New-Variable

语法

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

说明

New-Variable cmdlet 在 Windows PowerShell 中创建一个新变量。 可以在创建变量时为变量赋值，也可以在创建变量后分配或更改该值。

可以使用 New-Variable 的参数来设置变量的属性、设置变量的范围，并确定变量是公共变量还是私有变量。

通常，可以通过键入变量名及其值（如 $Var = 3）创建新变量，但可以使用 New-Variable cmdlet 来使用其参数。

示例

示例 1：创建变量

PS C:\> New-Variable days

此命令将创建一个名为 days 的新变量。 无需键入 Name 参数。

示例 2：创建变量并为其赋值

PS C:\> New-Variable -Name "zipcode" -Value 98033

此命令创建名为 zipcode 的变量，并为其分配值 98033。

示例 3：使用 ReadOnly 选项创建变量

PS C:\> New-Variable -Name Max -Value 256 -Option ReadOnly
PS C:\> New-Variable -Name max -Value 1024

New-Variable : A variable with name 'max' already exists.
At line:1 char:1
+ New-Variable -Name max -Value 1024
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : ResourceExists: (max:String) [New-Variable], SessionStateException
    + FullyQualifiedErrorId : VariableAlreadyExists,Microsoft.PowerShell.Commands.NewVariableCommand

PS C:\> New-Variable -Name max -Value 1024 -Force

此示例演示如何使用 new-Variable ReadOnly 选项来保护变量不被覆盖。

第一个命令创建名为 Max 的新变量，并将其值设置为 256。 它使用具有 ReadOnly 值的 Option 参数。

第二个命令尝试创建具有相同名称的第二个变量。 此命令返回错误，因为对变量设置了只读选项。

第三个命令使用 Force 参数替代变量上的只读保护。 在这种情况下，用于创建具有相同名称的新变量的命令成功。

示例 4：创建私有变量

PS C:\> New-Variable -Name counter -Visibility Private

#Effect of private variable in a module.

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"
At line:1 char:1
+ $counter
+ ~~~~~~~~
    + CategoryInfo          : PermissionDenied: (counter:String) [], SessionStateException
    + FullyQualifiedErrorId : VariableIsPrivate

PS C:\> Get-Counter
Name         Value
----         -----
Counter1     3.1415
...

此命令演示模块中私有变量的行为。 该模块包含 Get-Counter cmdlet，该 cmdlet 具有名为 Counter 的私有变量。 该命令使用 Visibility 参数和私有值来创建变量。

示例输出显示私有变量的行为。 加载模块的用户无法查看或更改 Counter 变量的值，但计数器变量可由模块中的命令读取和更改。

示例 5：使用空格创建变量

PS C:\> New-Variable -Name 'with space' -Value 'abc123xyz'

PS C:\> Get-Variable -Name 'with space'

Name                           Value
----                           -----
with space                     abc123xyz

PS C:\> ${with space}
abc123xyz

此命令演示可以创建具有空格的变量。 可以使用 Get-Variable cmdlet 或直接使用大括号分隔变量来访问变量。

参数

-Confirm

-Description

-Force

-Name

-Option

-PassThru

-Scope

-Value

-Visibility

-WhatIf

输入

Object

可以通过管道将值传递给 New-Variable。

输出

None or System.Management.Automation.PSVariable

使用 PassThru 参数时，New-Variable 生成表示新变量的 System.Management.Automation.PSVariable 对象。 否则，此 cmdlet 不会生成任何输出。

相关链接

• Clear-Variable
• Get-Variable
• Remove-Variable
• Set-Variable