Set-Variable

语法

Default （默认值）

Set-Variable
    [-Name] <String[]>
    [[-Value] <Object>]
    [-Include <String[]>]
    [-Exclude <String[]>]
    [-Description <String>]
    [-Option <ScopedItemOptions>]
    [-Force]
    [-Visibility <SessionStateEntryVisibility>]
    [-PassThru]
    [-Scope <String>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

说明

示例

Example 1: Set a variable and get its value

PS C:\> Set-Variable -Name "desc" -Value "A description"
PS C:\> Get-Variable -Name "desc"

Example 2: Set a global, read-only variable

PS C:\> Set-Variable -Name "processes" -Value (Get-Process) -Option constant -Scope global -Description "All processes" -PassThru | Format-List -Property *

Example 3: Understand public vs. private variables

PS C:\> New-Variable -Name "counter" -Visibility Public -Value 26
PS C:\> $Counter
26
PS C:\> Get-Variable c*

Name                  Value
----                  -----
Culture               en-US
ConsoleFileName
ConfirmPreference     High
CommandLineParameters {}
Counter               26

PS C:\> Set-Variable -Name "counter" -Visibility Private
PS C:\> Get-Variable c*

Name                  Value
----                  -----
Culture               en-US
ConsoleFileName
ConfirmPreference     High
CommandLineParameters {}

 PS C:\> $counter
"Cannot access the variable '$counter' because it is a private variable"

PS C:\> .\use-counter.ps1
#Commands completed successfully.

参数

-Confirm

Prompts you for confirmation before running the cmdlet.

参数属性

参数集

-Description

Specifies the description of the variable.

参数属性

参数集

-Exclude

Specifies an array of items that this cmdlet excludes from the operation. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as *.txt. Wildcards are permitted.

参数属性

参数集

-Force

Allows you to create a variable with the same name as an existing read-only variable, or to change the value of a read-only variable.

By default, you can overwrite a variable, unless the variable has an option value of ReadOnly or Constant. For more information, see the Option parameter.

参数属性

参数集

-Include

Specifies an array of items that this cmdlet includes in the operation. The value of this parameter qualifies the Name parameter. Enter a name or name pattern, such as c*. Wildcards are permitted.

参数属性

参数集

-Name

Specifies the variable name.

参数属性

参数集

-Option

Specifies the value of the Options property of the variable.

Valid values are:

• None: Sets no options. ("None" is the default.)
• ReadOnly: Can be deleted. Cannot be changed, except by using the Force parameter.
• Constant: Cannot be deleted or changed. "Constant" is valid only when you are creating a variable. You cannot change the options of an existing variable to "Constant".
• Private: The variable is available only in the current scope.
• AllScope: The variable is copied to any new scopes that are created.

To see the Options property of all variables in the session, type Get-Variable | Format-Table -Property name, options -Autosize.

参数属性

参数集

-PassThru

Returns an object representing the new variable. By default, this cmdlet does not generate any output.

参数属性

参数集

-Scope

Specifies the scope of the variable.The acceptable values for this parameter are:

• Global
• Local
• Script
• Private
• A number relative to the current scope (0 through the number of scopes, where 0 is the current scope and 1 is its parent).

Local is the default.

For more information, see about_Scopes.

参数属性

参数集

-Value

Specifies the value of the variable.

参数属性

参数集

-Visibility

Determines whether the variable is visible outside of the session in which it was created. This parameter is designed for use in scripts and commands that will be delivered to other users.

Valid values are:

• Public: The variable is visible. ("Public" is the default.)
• Private: The variable is not visible.

When a variable is private, it does not appear in lists of variables, such as those returned by Get-Variable, or in displays of the Variable: drive. Commands to read or change the value of a private variable return an error. However, the user can run commands that use a private variable if the commands were written in the session in which the variable was defined.

参数属性

参数集

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

参数属性

参数集

CommonParameters

输入

Object

输出

None or System.Management.Automation.PSVariable

相关链接

• Clear-Variable
• Get-Variable
• New-Variable
• Remove-Variable