![\"Hey,](\"https:\/\/devblogs.microsoft.com\/wp-content\/uploads\/sites\/29\/2019\/02\/q-for-powertip.jpg\" "\\"Hey,")
<\/H2>\n <\/H2>\nHey, Scripting Guy! The script you wrote yesterday to check the status of offline files was pretty cool. However, it does not help me if I want to enable or disable offline files on my computer. Do you have a script to allow me to actually dooooooooo something?
– LS<\/P>![\"Spacer\"](\"https:\/\/devblogs.microsoft.com\/scripting\/wp-content\/uploads\/sites\/29\/2019\/05\/spacer.gif\")
![\"Hey,](\"https:\/\/devblogs.microsoft.com\/wp-content\/uploads\/sites\/29\/2019\/02\/a-for-powertip.jpg\" "\\"Hey,")
\n
Hi LS,<\/P>\n
Doooooooooo we have a script that actually does something? Of course we do. We are outside playing Frisbee golf on the green lawn here on campus. Scripting Guy Ed Wilson is sitting under a tree, ostensibly watching us, but we suspect he is actually writing a script. This guy writes scripts in his sleep (or so we have been told). Hey, Ed, can you write a script to enable and disable offline files? LS, we will get back with you. It is our turn to putt (said in the whisper of Jim Nantz).<\/P>\n
Okay, we are back. Ed has cooked up a pretty good one today. He calls it the EnableDisableOfflineFiles.ps1<\/B> script. He must be feeling creative. Here it is in its entirety.<\/P>\n
EnableDisableOfflineFiles.ps1<\/B><\/P> function funline ($strIN)\n{\n $num = $strIN.length\n for($i=1 ; $i -le $num ; $i++)\n { $funline += “=” }\n Write-Host -ForegroundColor yellow $strIN \n Write-Host -ForegroundColor darkYellow $funline\n}<\/p>\n function funHelp()\n{\n$helpText=@”\nDESCRIPTION:\nNAME: EnableDisableOffLineFiles.ps1 \nEnables or disables offline files on a local or remote machine.\nA reboot of the machine MAY be required. This information will\nbe displayed in the status message once the script is run.<\/p>\n PARAMETERS: \n-computer Specifies name of the computer upon which to run the script\n-a(ction) < e(nable), d(isable) >\n-help prints help file<\/p>\n SYNTAX:\nEnableDisableOffLineFiles.ps1 -computer MunichServer -a e<\/p>\n Enables offline files on a computer named MunichServer<\/p>\n EnableDisableOffLineFiles.ps1 -a d<\/p>\n Disables offline files on local computer<\/p>\n EnableDisableOffLineFiles.ps1 -help ?<\/p>\n Displays the help topic for the script<\/p>\n “@\n$helpText\nexit\n}<\/p>\n function funtranslatemethod($a)\n{\n switch($a)\n {\n “e” { $glogal:m = $true \n $global:msg = “Enable offline files” \n }\n “d” { \n $global:m = $false\n $global:msg = “Disable offline files” \n }\n default{ \n $global:msg = “$a is not an allowed response`n” \n }\n }\n}<\/p>\n if($help){ funline(“Obtaining help …”) ; funhelp }\nif(!$a)\n {\n $(throw “You must supply an action. try this:\nEnableDIsableOfflineFiles.ps1 -help ?”)\n }\n$global:msg =$global:m = $null\nfuntranslatemethod($a)<\/p>\n $objWMI = [wmiclass]”\\\\$computer\\root\\cimv2:win32_offlinefilescache”\nfunline(“Configure Offline files on $computer …”)\n$rtn = $objwmi.enable($m)\nif($rtn.returnvalue -eq 0)\n {\n Write-Host -ForegroundColor green “$msg succeeded”\n }\nELSE\n {\n Write-Host -ForegroundColor red “$msg failed with $($rtn.returnvalue) ”\n }\nif($rtn.rebootrequired) \n { Write-Host -ForegroundColor cyan “reboot required” }\n<\/PRE>\n To enable or to disable the offline files feature on more than one machine or as part of a standard build process, you can use the EnableDisableOfflineFiles.ps1<\/B> script. This script leverages the WIN32_Offlinefilescache<\/B> WMI class. <\/P>\n The EnableDisableOfflineFiles.ps1<\/B> script begins with the param<\/B> statement. The param<\/B> statement is used to provide us with the ability to specify named arguments to the script when it runs. This gives the ability to control how the script executes without having to edit the script. The first parameter defined is the \u2013computer<\/B> parameter. The $computer<\/B> variable is automatically created to hold the data supplied when the script is run. However, we decided to set the variable to a default value of localhost<\/B>. This allows us to run the script against the local machine without having to actually supply a value to use. We define two other parameters: -a<\/B> and \u2013help<\/B>. We do not assign default values to these variables. The \u2013a<\/B> parameter will be used to specify the action to perform when the script is run. The \u2013help<\/B> parameter determines whether or not the Help text is displayed. This line of code is seen here: <\/P> Next, we have the funline<\/B> function. The funline<\/B> function is used to underline the output from the script and to provide a visual reference point to make the output easier to read and to understand. We declare a single input statement to the function, which is called $strIN<\/B>. The input string is whatever is passed to the funline<\/B> function. We use the length<\/B> property to determine the length of the line that was passed to the function. We store the length of the string in the b<\/B> variable, and use it in the for<\/B> loop. We begin counting at 1 and will continue looping until the value of $i<\/B> (the counter variable) is less than or equal to the sum stored in the $num<\/B> variable. We then increment the value of $i<\/B> by 1 ($i++<\/B>). The code that is run as a result of the for<\/B> loop is used to build up the variable $funline<\/B> with a group of equal signs (\u201c=<\/B>\u201d). We then use the Write-Host<\/B> cmdlet to print out the input string. We specify the \u2013foregroundcolor<\/B> parameter of yellow<\/B>, and the line separator contained in the $funline<\/B> function is printed out using the \u2013foregroundcolor<\/B> parameter of darkyellow<\/B>. This gives a nice visual effect to the line separator. This function is seen here:<\/P> Now we come to the fun<\/B>H<\/B>elp<\/B> function. This function is used to display a Help message to the user when the script is run with the \u2013help<\/B> parameter specified. There are no input parameters defined for this function. We begin the function by declaring the variable $helpText<\/B> and opening a here-string<\/B>. The here-string<\/B> is opened by using the special character combination @\u201d<\/B>. The here-string<\/B> uses the same character combination in reverse \u201c@<\/B> to end the here-string<\/B>. The advantage of using the here-string<\/B> is that it allows us to ignore quoting rules, and simply type the text as we wish it to appear in the output. In the here-string<\/B>, we define sections of Help such as a general description of the script, the parameters the script requires, and several syntax examples. The funHelp<\/B> function ends by displaying the contents of the $helpText<\/B> variable and calling the exit statement. The entire funHelp<\/B> function is seen here:<\/P> PARAMETERS: \n-computer Specifies name of the computer upon which to run the script\n-a(ction) < e(nable), d(isable) >\n-help prints help file<\/p>\n SYNTAX:\nEnableDisableOffLineFiles.ps1 -computer MunichServer -a e<\/p>\n Enables offline files on a computer named MunichServer<\/p>\n EnableDisableOffLineFiles.ps1 -a d<\/p>\n Disables offline files on local computer<\/p>\n EnableDisableOffLineFiles.ps1 -help ?<\/p>\n Displays the help topic for the script<\/p>\n “@\n$helpText\nexit\n}\n<\/PRE>\n After we are finished with the funhelp<\/B> function, we move on to declare an additional function\u2014the funtranslatemethod<\/B> function. The funtranslatemethod<\/B> function is used to translate the input parameter that is specified for the \u2013a<\/B> (action) parameter. The value that will be contained in the $a<\/B> variable is supplied when the script is run. In fact, this script will generate an error if the \u2013a<\/B> parameter is missing when the script is run. This makes sense because you need to know if you want to either enable or disable offline files before you run the script. <\/P>\n The funtranslatemethod<\/B> function uses the switch<\/B> statement to evaluate the value that was supplied to the \u2013a<\/B> parameter. If the value contained in the $a<\/B> variable is the letter e<\/B>, we do two things inside the code block. We first assign the intrinsic variable $true<\/B> to the global variable $m<\/B>. The second thing we do is use the global variable $msg<\/B> and store the string we will display to the user. We use the string \u201cEnable offline files\u201d to indicate the action we were trying to perform. <\/P>\n The other action we have defined in the funtranslatemethod<\/B> function is the disable<\/B> action. If the user supplies the letter b to the script when it is run, we will use the global variable $m<\/B> to hold the intrinsic variable b<\/B>. This will be supplied to the method<\/B> call in the main body of the script a little bit later. We also store a string\u2014\u201cDisable offline files\u201d\u2014in the global variable $msg<\/B>. <\/P>\n The default action of the switch<\/B> statement is to store the string \u201cis not an allowed response\u201d in the global variable $msg<\/B>. We also print out the value of the action that was contained in the $a<\/B> variable, and use a special character \u201c`n\u201d to cause the string to be printed with a new line character at the end of the string. The complete funtranslatemethod<\/B> function is seen here:<\/P> Now we need to check for the presence of a couple of variables. The first variable we want to check for is the $help<\/B> variable. If it is present, it means the script was run with the \u2013help<\/B> parameter, and we want to display the help text as a result. To do this, we use the if<\/B> statement and look for the variable. If it is found, in our code block we call the funline<\/B> function to display a string message, and then call the funhelp<\/B> function. This line of code is seen here:<\/P> Next we look for the presence of the $a<\/B> variable. If it is not present, it means the script was run without the $a<\/B> parameter. We want this parameter to be a required parameter, and as a result, we use the throw<\/B> statement to display a message. When we use the throw<\/B> statement, it will halt execution of the script and display our message in red. This is similar to using the raise<\/B> method of the error<\/B> object in other programming languages.<\/P>\n The string that we will \u201cthrow\u201d is used to indicate the error that occurred\u2014a value for the \u2013a<\/B> parameter was not supplied. This error is shown here:<\/P> <\/P>\n We then point the user to the Help file:<\/P> If the user does not want to see the Help<\/B> file, and they have supplied a value for the action<\/B> parameter, we declare a couple of global variables, set them to null, and then call the funtranslatemethod<\/B> function to see which action we need to perform. These two lines of code are seen here: <\/P> It is now time to make the connection into WMI. To do this, we use the [wmiclass]<\/B> type accelerator, which provides access to the system.management.managementobject<\/B> .NET Framework class. This .NET Framework class provides access to the WMI methods that might not be available when using the Get-Wmiobject<\/B> cmdlet. Luckily, we can use the Get-Member<\/B> cmdlet and the Windows Software Development Kit (SDK) to provide additional information about calling the methods. The syntax to connect to a remote computer using this class is a bit strange as seen below. We incorporate the $computer<\/B> variable that is supplied from the command line into the connection string to make it easy to target other computers. We store the system.management.managementobject<\/B> that is created in the $objWMI<\/B> variable. This line of code is seen here:<\/P> Now we want to call the enable<\/B> method, and either enable or disable the use of the offline files feature in Windows Server 2008 R2 or Windows Vista. We use the funline<\/B> function to print out the status message, and then we call the enable()<\/B> method. This code is seen here:<\/P> Next, we want to evaluate the return code that came back from calling the enable<\/B> method on the machine. If the returnvalue<\/B> property of the return code is equal to 0, the call succeeded. Otherwise, we print out the return code and state the call was not successful. The problem with this WMI class is that it does not always supply a non-zero return value. However, the class always returns a 0 when it succeeds. This code is seen here:<\/P> We also need to check the rebootrequired<\/B> property. When the enable<\/B> method \u201cworks\u201d but detects that a reboot is required, it will set the rebootrequired<\/B> property. We look for it and display that the reboot is required. This code is seen here:<\/P> LS, we got a hole in one in our Frisbee golf game, and Ed appears to have scored a hole in one with the EnableDisableOfflineFiles.ps1<\/B> script. Join us tomorrow as we continue Managing User Data Week. Hey, the Summer Scripting Games are nearly upon us. We will begin revealing the event scenarios next week. So stay tuned.<\/P>\n <\/P>\n Ed Wilson and Craig Liebendorfer, Scripting Guys<\/B><\/P><\/p>\n","protected":false},"excerpt":{"rendered":" Hey, Scripting Guy! The script you wrote yesterday to check the status of offline files was pretty cool. However, it does not help me if I want to enable or disable offline files on my computer. Do you have a script to allow me to actually dooooooooo something?– LS Hi LS, Doooooooooo we have a […]<\/p>\n","protected":false},"author":595,"featured_media":87096,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[1],"tags":[423,3,735,45],"class_list":["post-53603","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-scripting","tag-backup-and-system-restore","tag-scripting-guy","tag-shadow-copy","tag-windows-powershell"],"acf":[],"blog_post_summary":" Hey, Scripting Guy! The script you wrote yesterday to check the status of offline files was pretty cool. However, it does not help me if I want to enable or disable offline files on my computer. Do you have a script to allow me to actually dooooooooo something?– LS Hi LS, Doooooooooo we have a […]<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/posts\/53603","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/users\/595"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/comments?post=53603"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/posts\/53603\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/media\/87096"}],"wp:attachment":[{"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/media?parent=53603"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/categories?post=53603"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/tags?post=53603"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}param($computer=”localhost”, $a, $help)<\/p>\n
param($computer=”localhost”, $a, $help)\n<\/PRE>\n
function funline ($strIN)\n{\n $num = $strIN.length\n for($i=1 ; $i -le $num ; $i++)\n { $funline += “=” }\n Write-Host -ForegroundColor yellow $strIN \n Write-Host -ForegroundColor darkYellow $funline\n}\n<\/PRE>\nfunction funHelp()\n{\n$helpText=@”\nDESCRIPTION:\nNAME: EnableDisableOffLineFiles.ps1 \nEnables or disables offline files on a local or remote machine.\nA reboot of the machine MAY be required. This information will\nbe displayed in the status message once the script is run.<\/p>\nfunction funtranslatemethod($a)\n{\n switch($a)\n {\n “e” { $global:m = $true \n $global:msg = “Enable offline files” \n }\n “d” { \n $global:m = $false\n $global:msg = “Disable offline files” \n }\n default{ \n $global:msg = “$a is not an allowed response`n” \n }\n }\n}\n<\/PRE>\nif($help){ funline(“Obtaining help …”) ; funhelp }\n<\/PRE>\n![\"Image](\"http:\/\/img.microsoft.com\/library\/media\/1033\/technet\/images\/scriptcenter\/qanda\/hsg\/2009\/june\/hey0603\/hsg-06-03-09-01.jpg\")
\nif(!$a)\n {\n $(throw “You must supply an action. try this:\nEnableDIsableOfflineFiles.ps1 -help ?”)\n }\n<\/PRE>\n$global:msg = $global:m = $null\nfuntranslatemethod($a)\n<\/PRE>\n
$objWMI = [wmiclass]”\\\\$computer\\root\\cimv2:win32_offlinefilescache”\n<\/PRE>\n
funline(“Configure Offline files on $computer …”)\n$rtn = $objwmi.enable($m)\n<\/PRE>\n
if($rtn.returnvalue -eq 0)\n {\n Write-Host -ForegroundColor green “$msg succeeded”\n }\nELSE\n {\n Write-Host -ForegroundColor red “$msg failed with $($rtn.returnvalue) ”\n }\n<\/PRE>\nif($rtn.rebootrequired) \n { Write-Host -ForegroundColor cyan “reboot required” }\n<\/PRE>\n