ISESteroids

2.2.0.12

HelpCache/Microsoft.WindowsSearch.Commands.dll-help.xml

<?xml version="1.0" encoding="utf-8"?>
<helpItems xmlns="http://msh" schema="maml">
  <!-- Updatable Help Version 4.0.2.0 -->
  <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
    <command:details>
      <command:name>Get-WindowsSearchSetting</command:name>
      <maml:description>
        <maml:para>Gets the values of settings for Windows Search. </maml:para>
      </maml:description>
      <maml:copyright>
        <maml:para />
      </maml:copyright>
      <command:verb>Get</command:verb>
      <command:noun>WindowsSearchSetting</command:noun>
      <dev:version />
    </command:details>
    <maml:description>
      <maml:para>The Get-WindowsSearchSettings cmdlet gets the values of settings for Windows Search. You can view settings for whether Windows Search displays web results or suggestions and whether to display web results and suggestions while using a metered network. You can view settings for whether Windows Search personalizes results, including whether Windows Search employs the specific location of the user. You can also see SafeSearch settings. </maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>Get-WindowsSearchSetting</maml:name>
      </command:syntaxItem>
    </command:syntax>
    <command:parameters>
    </command:parameters>
    <command:inputTypes>
      <command:inputType>
        <dev:type>
          <maml:name>
          </maml:name>
          <maml:uri>
          </maml:uri>
          <maml:description>
            <maml:para />
          </maml:description>
        </dev:type>
        <maml:description>
        </maml:description>
      </command:inputType>
    </command:inputTypes>
    <command:returnValues>
      <command:returnValue>
        <dev:type>
          <maml:name>WindowsSearchSetting</maml:name>
          <maml:uri>
          </maml:uri>
          <maml:description>
            <maml:para />
          </maml:description>
        </dev:type>
        <maml:description>
          <maml:para>Returns the values of properties that control Windows Search: </maml:para>
          <maml:para>-- EnableMeteredWebResultsSetting. Whether Windows Search displays web results and suggestions while using a metered network.
-- EnableWebResultsSetting. Whether Windows Search displays web results and suggestions.
-- SearchExperienceSetting. The experience setting.
-- WindowsSafeSearchSetting. The value of SafeSearch that Windows Search uses for queries.</maml:para>
          <maml:para>SearchExperienceSetting has the following possible values:
 
-- PersonlizedAndLocation. Personalize Windows Search and other Microsoft experiences by using search history, some Microsoft account information, and specific location of the user.
-- Personalized. Personalize Windows Search and other Microsoft experiences by using search history and some Microsoft account information, but do not use specific location of the user.
-- NotPersonalized. Do not personalize Windows Search and other Microsoft experiences or use specific location of the user.</maml:para>
          <maml:para>WindowsSafeSearchSetting has the following possible values:
 
-- Off. Windows Search does not remove adult content from results.
-- Moderate. Windows Search excludes adult images and videos, but not text, from results.
-- Strict. Windows Search excludes adult images, videos, and text from results.</maml:para>
        </maml:description>
      </command:returnValue>
    </command:returnValues>
    <command:terminatingErrors />
    <command:nonTerminatingErrors />
    <command:examples>
      <command:example>
        <maml:title>Example 1: Get Windows Search settings</maml:title>
        <maml:introduction>
          <maml:para>
          </maml:para>
        </maml:introduction>
        <dev:code>PS C:\&gt; Get-WindowsSearchSetting
Setting Value
------- -----
EnableWebResultsSetting True
EnableMeteredWebResultsSetting True
SearchExperience PersonalizedAndLocation
WindowsSafeSearchSetting Moderate
 
</dev:code>
        <dev:remarks>
          <maml:para>This command gets Windows Search settings. The console displays the values for the settings.</maml:para>
        </dev:remarks>
        <command:commandLines>
          <command:commandLine>
            <command:commandText />
          </command:commandLine>
        </command:commandLines>
      </command:example>
    </command:examples>
    <maml:relatedLinks>
      <maml:navigationLink>
        <maml:linkText>Online Version:</maml:linkText>
        <maml:uri>http://go.microsoft.com/fwlink/?LinkID=294363</maml:uri>
      </maml:navigationLink>
      <maml:navigationLink>
        <maml:linkText>Set-WindowsSearchSetting</maml:linkText>
        <maml:uri />
      </maml:navigationLink>
    </maml:relatedLinks>
  </command:command>
  <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
    <command:details>
      <command:name>Set-WindowsSearchSetting</command:name>
      <maml:description>
        <maml:para>Modifies values that control Windows Search. </maml:para>
      </maml:description>
      <maml:copyright>
        <maml:para />
      </maml:copyright>
      <command:verb>Set</command:verb>
      <command:noun>WindowsSearchSetting</command:noun>
      <dev:version />
    </command:details>
    <maml:description>
      <maml:para>The Set-WindowsSearchSetting cmdlet modifies values that control Windows Search. You can specify whether Windows Search displays web results or suggestions, and you can specify whether to display web results and suggestions while using a metered network. You can specify whether Windows Search personalizes results, including whether Windows Search employs the specific location of the user. You can also specify SafeSearch settings. </maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>Set-WindowsSearchSetting</maml:name>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="">
          <maml:name>EnableMeteredWebResultsSetting</maml:name>
          <maml:description>
            <maml:para>Indicates whether Windows Search displays web results and suggestions while using metered connections. Specify a value of $True to display web results and suggestions over metered connections or a value of $False to exclude web results and suggestions.</maml:para>
            <maml:para>Do not specify a value for this parameter if the value of the EnableWebResultsSetting parameter is $False.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="">
          <maml:name>EnableWebResultsSetting</maml:name>
          <maml:description>
            <maml:para>Indicates whether Windows Search displays web results and suggestions. Specify a value of $True to display web results and suggestions or a value of $False to exclude web results and suggestions. </maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="">
          <maml:name>SafeSearchSetting</maml:name>
          <maml:description>
            <maml:para>Specifies a SafeSearch setting for Window Search. The acceptable values for this parameter are: 
 
-- Off. Windows Search does not remove adult content from results.
-- Moderate. Windows Search excludes adult images and videos, but not text, from results.
-- Strict. Windows Search excludes adult images, videos, and text from results.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="">
          <maml:name>SearchExperienceSetting</maml:name>
          <maml:description>
            <maml:para>Specifies a Windows Search experience setting. The acceptable values for this parameter are: 
 
-- PersonlizedAndLocation. Personalize Windows Search and other Microsoft experiences by using search history, some Microsoft account information, and specific location of the user.
-- Personalized. Personalize Windows Search and other Microsoft experiences by using search history and some Microsoft account information, but do not use specific location of the user.
-- NotPersonalized. Do not personalize Windows Search and other Microsoft experiences or use specific location of the user.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        </command:parameter>
      </command:syntaxItem>
    </command:syntax>
    <command:parameters>
      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="">
        <maml:name>EnableMeteredWebResultsSetting</maml:name>
        <maml:description>
          <maml:para>Indicates whether Windows Search displays web results and suggestions while using metered connections. Specify a value of $True to display web results and suggestions over metered connections or a value of $False to exclude web results and suggestions.</maml:para>
          <maml:para>Do not specify a value for this parameter if the value of the EnableWebResultsSetting parameter is $False.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue>
        <dev:type>
          <maml:name>Boolean</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>
        </dev:defaultValue>
      </command:parameter>
      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="">
        <maml:name>EnableWebResultsSetting</maml:name>
        <maml:description>
          <maml:para>Indicates whether Windows Search displays web results and suggestions. Specify a value of $True to display web results and suggestions or a value of $False to exclude web results and suggestions. </maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue>
        <dev:type>
          <maml:name>Boolean</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>
        </dev:defaultValue>
      </command:parameter>
      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="">
        <maml:name>SafeSearchSetting</maml:name>
        <maml:description>
          <maml:para>Specifies a SafeSearch setting for Window Search. The acceptable values for this parameter are: 
 
-- Off. Windows Search does not remove adult content from results.
-- Moderate. Windows Search excludes adult images and videos, but not text, from results.
-- Strict. Windows Search excludes adult images, videos, and text from results.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        <dev:type>
          <maml:name>String</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>
        </dev:defaultValue>
      </command:parameter>
      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="">
        <maml:name>SearchExperienceSetting</maml:name>
        <maml:description>
          <maml:para>Specifies a Windows Search experience setting. The acceptable values for this parameter are: 
 
-- PersonlizedAndLocation. Personalize Windows Search and other Microsoft experiences by using search history, some Microsoft account information, and specific location of the user.
-- Personalized. Personalize Windows Search and other Microsoft experiences by using search history and some Microsoft account information, but do not use specific location of the user.
-- NotPersonalized. Do not personalize Windows Search and other Microsoft experiences or use specific location of the user.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        <dev:type>
          <maml:name>String</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>
        </dev:defaultValue>
      </command:parameter>
    </command:parameters>
    <command:inputTypes>
      <command:inputType>
        <dev:type>
          <maml:name>
          </maml:name>
          <maml:uri>
          </maml:uri>
          <maml:description>
            <maml:para />
          </maml:description>
        </dev:type>
        <maml:description>
        </maml:description>
      </command:inputType>
    </command:inputTypes>
    <command:returnValues>
      <command:returnValue>
        <dev:type>
          <maml:name>
          </maml:name>
          <maml:uri>
          </maml:uri>
          <maml:description>
            <maml:para />
          </maml:description>
        </dev:type>
        <maml:description>
        </maml:description>
      </command:returnValue>
    </command:returnValues>
    <command:terminatingErrors />
    <command:nonTerminatingErrors />
    <command:examples>
      <command:example>
        <maml:title>Example 1: Personalize Windows Search</maml:title>
        <maml:introduction>
          <maml:para>
          </maml:para>
        </maml:introduction>
        <dev:code>PS C:\&gt; Set-WindowsSearchSetting -SearchExperienceSetting "Personalized"
</dev:code>
        <dev:remarks>
          <maml:para>This command allows Windows Search to use search history, but not specific location of the user, to personalize results.</maml:para>
        </dev:remarks>
        <command:commandLines>
          <command:commandLine>
            <command:commandText />
          </command:commandLine>
        </command:commandLines>
      </command:example>
      <command:example>
        <maml:title>Example 2: Modify Windows Search settings</maml:title>
        <maml:introduction>
          <maml:para>
          </maml:para>
        </maml:introduction>
        <dev:code>PS C:\&gt;Set-WindowsSearchSetting -EnableWebResultsSetting $True -SafeSearchSetting "Strict" -SearchExperienceSetting "PersonlizedAndLocation"
 
</dev:code>
        <dev:remarks>
          <maml:para>This command modifies Windows Search settings. The command enables the use of search history and specific location of the user by specifying a value of PersonlizedAndLocation for the SearchExperienceSetting parameter. The command enables web results and sets SafeSearch to a value of Strict.</maml:para>
        </dev:remarks>
        <command:commandLines>
          <command:commandLine>
            <command:commandText />
          </command:commandLine>
        </command:commandLines>
      </command:example>
    </command:examples>
    <maml:relatedLinks>
      <maml:navigationLink>
        <maml:linkText>Online Version:</maml:linkText>
        <maml:uri>http://go.microsoft.com/fwlink/?LinkID=294364</maml:uri>
      </maml:navigationLink>
      <maml:navigationLink>
        <maml:linkText>Get-WindowsSearchSetting</maml:linkText>
        <maml:uri />
      </maml:navigationLink>
    </maml:relatedLinks>
  </command:command>
</helpItems>