New-Variable
建立新變數。
Syntax
New-Variable
[-Name] <String>
[[-Value] <Object>]
[-Description <String>]
[-Option <ScopedItemOptions>]
[-Visibility <SessionStateEntryVisibility>]
[-Force]
[-PassThru]
[-Scope <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Cmdlet 會在 New-Variable
PowerShell 中建立新的變數。 您可以在建立變數時指派值給變數,或者在建立後指派或變更變數的值。
您可以使用 的參數 New-Variable
來設定變數的屬性、設定變數的範圍,以及判斷變數是公用還是私用。
一般而言,您可以輸入變數名稱和其值來建立新的變數,例如 $Var = 3
,但您可以使用 New-Variable
Cmdlet 來使用其參數。
範例
範例 1︰建立變數
New-Variable days
此命令會建立名為 days 的新參數。 您不需要輸入 Name 參數。
範例 2︰建立變數並指派其值
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
此範例示範如何使用 ReadOnly
的選項 New-Variable
來保護變數免於被覆寫。
第一個命令會建立名為 Max 的新變數,並將它的值設為 256。 它會使用 Option 參數與 值 ReadOnly
。
第二個命令會嘗試建立名稱相同的第二個變數。 此命令會傳回錯誤,因為變數上已設定唯讀選項。
第三個命令會使用 Force 參數來覆寫變數上的唯讀保護。 在此情況下,使用相同名稱建立新變數的命令可以成功執行。
範例 4:將多個選項指派給變數
New-Variable -Name 'TestVariable' -Value 'Test Value' -Option AllScope,Constant
此範例會建立變數並指派 AllScope
和 Constant
選項,讓變數可在目前的範圍中使用,以及建立且無法變更或刪除的任何新範圍。
範例 5:Create 私用變數
此命令示範模組中私用變數的行為。 模組包含 Get-Counter
Cmdlet,其具有名為 Counter 的私人變數。 此命令會使用值為 Private 的 Visibility 參數來建立變數。
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
...
範例輸出會顯示私用變數的行為。 載入模組的使用者無法檢視或變更 Counter 變數的值,但模組中的命令可以讀取及變更 Counter 變數。
範例 6:使用空格 Create 變數
此範例示範可以建立具有空格的變數。 您可以使用 Cmdlet 或直接使用大括弧分隔變數來存取 Get-Variable
變數。
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
參數
-Confirm
在執行 Cmdlet 前提示您確認。
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Description
指定變數的描述。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Force
指出 Cmdlet 會使用和現有唯讀變數相同的名稱建立新變數。
根據預設,除非變數具有 或Constant
的選項值ReadOnly
,否則您可以覆寫變數。 如需詳細資訊,請參閱 Option 參數。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Name
指定新變數的名稱。
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Option
指定變數的 Options 屬性值。 此參數可接受的值為:
None
- 不設定任何選項。None
是預設值。ReadOnly
- 可以刪除。 無法使用 Force 參數來變更。Private
- 變數僅適用於目前的範圍。AllScope
- 變數會複製到任何已建立的新範圍。Constant
- 無法刪除或變更。Constant
只有在您建立變數時才有效。 您無法將現有變數的選項變更為Constant
。
這些值會定義為旗標型列舉。 您可以使用此參數將多個值結合在一起,以設定多個旗標。 這些值可以當做值的陣列或這些值的逗號分隔字串傳遞至 Option 參數。 Cmdlet 會使用二進位 OR 作業來合併值。 將值當做數位傳遞是最簡單的選項,也可讓您在值上使用 Tab 鍵自動完成。
若要查看工作階段中所有變數的 Options 屬性,請輸入 Get-Variable | Format-Table -Property name, options -AutoSize
。
Type: | ScopedItemOptions |
Accepted values: | None, ReadOnly, Constant, Private, AllScope, Unspecified |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-PassThru
傳回代表您正在使用之項目的物件。 根據預設,此 Cmdlet 不會產生任何輸出。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Scope
指定新變數的範圍。 此參數可接受的值為:
Global
- 在全域範圍中建立的變數可在PowerShell程式中的任何地方存取。Local
- 本機範圍是指目前的範圍,視內容而定,這可以是任何範圍。Local
為未指定 scope 參數時的預設範圍。Script
- 腳本範圍中建立的變數只能在建立的腳本檔案或模組記憶體取。- 相對於目前範圍的數位 (0 到範圍數目,其中 0 是目前的範圍,1 是其父系,2 父系範圍,依此類) 。 無法使用負數。
注意
參數也接受的值 Private
。 Private
實際上不是範圍,而是變數的選擇性設定。 不過,使用此 Private
Cmdlet 的值並不會變更變數的可見性。 如需詳細資訊,請參閱 about_Scopes。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Value
指定變數的初始值。
Type: | Object |
Position: | 1 |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Visibility
決定是否可在變數建立所在的工作階段之外看見變數。 此參數是針對將傳遞給其他使用者的指令碼和命令中使用所設計。 此參數可接受的值為:
Public
- 變數是可見的。Public
是預設值。Private
- 變數不可見。
當變數為私用時,它不會出現在變數清單中,例如所傳 Get-Variable
回的變數,或在磁碟驅動器的 Variable:
顯示中。 讀取或變更私用變數值的命令會傳回錯誤。 但是,如果命令是寫入在定義變數的工作階段中,使用者就可以執行使用私用變數的命令。
Type: | SessionStateEntryVisibility |
Accepted values: | Public, Private |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WhatIf
顯示執行 Cmdlet 後會發生的情況。 Cmdlet 並不會執行。
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
輸入
您可以使用管線將任何物件傳送至 New-Variable
。
輸出
None
根據預設,此 Cmdlet 不會傳回任何輸出。
當您使用 PassThru 參數時,此 Cmdlet 會傳回代表新變數的 PSVariable 物件。
備註
PowerShell 包含的下列別名 New-Variable
:
- 所有平台:
nv