Set-Variable

  • 參考
模組:
Microsoft.PowerShell.Utility

設定變數的值。 如果其中一個具有要求的名稱不存在，則建立變數。

Syntax

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

Description

Cmdlet 會將 Set-Variable 值指派給指定的變數，或變更目前的值。 如果變數不存在，Cmdlet 會建立它。

範例

範例 1：設定變數並取得其值

這些命令會將變數的值 $desc 設定為 A description，然後取得變數的值。

Set-Variable -Name "desc" -Value "A description"
Get-Variable -Name "desc"

Name                           Value
----                           -----
desc                           A description

範例 2：設定全域只讀變數

此範例會建立全域只讀變數，其中包含系統上的所有進程，然後顯示變數的所有屬性。

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

命令會 Set-Variable 使用 Cmdlet 來建立變數。 它會使用 PassThru 參數來建立代表新變數的物件，並使用管線運算元 （|） 將對象傳遞至 Format-List Cmdlet。 它會使用 的 Property 參數 Format-List 搭配 all 值 （*） 來顯示新建立變數的所有屬性。

值 (Get-Process)會以括弧括住，以確保在變數中儲存之前執行該值。 否則，變數會包含字 Get-Process組 。

範例 3：瞭解公用變數與私用變數

這個範例示範如何將變數的可見性變更為 Private。 此變數可由具有必要許可權的腳本讀取和變更，但使用者看不到此變數。

New-Variable -Name "counter" -Visibility Public -Value 26
$Counter

26

Get-Variable c*

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

Set-Variable -Name "counter" -Visibility Private
Get-Variable c*

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

$counter

"Cannot access the variable '$counter' because it is a private variable"

.\use-counter.ps1
#Commands completed successfully.

此命令示範如何將變數的可見性變更為 Private。 此變數可由具有必要許可權的腳本讀取和變更，但使用者看不到此變數。

參數

-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

-Exclude

指定此 Cmdlet 從作業中排除的項目陣列。 此參數的值會 限定Path 參數。 輸入路徑專案或模式，例如 *.txt。 允許通配符。

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:True

-Force

可讓您建立名稱與現有唯讀變數相同的變數，或變更只讀變數的值。

根據預設，您可以覆寫變數，除非變數具有 或Constant的選項值ReadOnly。 如需詳細資訊，請參閱 Option 參數。

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Include

指定此 Cmdlet 包含在作業中的項目陣列。 此參數的值會 限定Name 參數。 輸入名稱或名稱模式，例如 c*。 允許通配符。

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:True

-Name

指定變數名稱。

Type:String[]
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Option

指定變數的 Options 屬性值。

有效值為：

  • None：不設定任何選項。 （None 是預設值。
  • ReadOnly：可以刪除。 除非使用 Force 參數，否則無法變更。
  • Constant：無法刪除或變更。 Constant 只有在您建立變數時才有效。 您無法將現有變數的選項變更為 Constant。
  • Private：變數只能在目前的範圍內使用。
  • AllScope：變數會複製到任何已建立的新範圍。

這些值會定義為旗標型列舉。 您可以將多個值結合在一起，以使用此參數來設定多個旗標。 這些值可以傳遞至 Option 參數做為值的陣列，或是這些值的逗號分隔字串。 Cmdlet 會使用二進位 OR 作業來合併值。 將值當做數位傳遞是最簡單的選項，也可讓您在值上使用 Tab 鍵自動完成。

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:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Scope

指定變數的範圍。此參數可接受的值為：

  • Global
  • Local
  • Script
  • Private
  • 相對於目前範圍的數位（0 到範圍的數目，其中0是目前的範圍，1是其父系）。

Local 是預設值。

如需詳細資訊，請參閱 about_Scopes。

Type:String
Position:Named
Default value:Local
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:Public
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

輸入

Object

您可以使用管線將代表變數值的物件傳送至這個 Cmdlet。

輸出

None

根據預設，此 Cmdlet 不會傳回任何輸出。

PSVariable

當您使用 PassThru 參數時，這個 Cmdlet 會 傳回代表新變數或已變更變數的 PSVariable 物件。

備註

PowerShell 包含下列的 Set-Variable別名：

  • 所有平臺：
    • set
    • sv