Set-Variable

模組:
Microsoft.PowerShell.Utility Module

設定變數的值。 若不存在請求名稱的變數，則建立該變數。

語法

Default (預設值) 

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

Description

指令 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。 它使用 PropertyFormat-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.

此指令展示了如何將變數的可見性改為私密。 此變數可由具備所需權限的腳本讀取與更改，但使用者無法看到。

參數

-Confirm

在執行 Cmdlet 之前，提示您進行確認。

參數屬性

類型:SwitchParameter
預設值:False
支援萬用字元:False
不要顯示:False
別名:參見

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Description

指定變數的描述。

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Exclude

指定一個由此 cmdlet 排除於操作中的項目陣列。 此參數的值對 路徑 參數進行限定。 輸入路徑元素或模式，例如 *.txt。 允許使用通配符。

參數屬性

類型:

String[]

預設值:None
支援萬用字元:True
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Force

允許你建立與現有唯讀變數同名的變數，或更改只讀變數的值。

預設情況下，你可以覆寫變數，除非該變數的選項值為 ReadOnly 或 Constant。 欲了解更多資訊，請參閱 選項 參數。

參數屬性

類型:SwitchParameter
預設值:False
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Include

指定此 cmdlet 在操作中包含的項目陣列。 此參數的值用來說明 Name 參數。 輸入名稱或名稱模式，例如 c*。 允許使用通配符。

參數屬性

類型:

String[]

預設值:None
支援萬用字元:True
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Name

指定變數名稱。

參數屬性

類型:

String[]

預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:0
必要:True
來自管線的值:False
來自管線按屬性名稱的值:True
來自剩餘引數的值:False

-Option

指定變數的 Options 屬性值。

有效值為：

  • None： 沒有設定任何選項。 （None 是預設值。）
  • ReadOnly： 可以刪除。 無法更改，除非使用力場參數。
  • Constant： 無法刪除或更改。 Constant 只有在建立變數時才有效。 你無法將現有變數的選項改為 Constant。
  • Private：變數僅在當前範圍內可用。
  • AllScope： 變數會被複製到任何新建立的範圍。

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

參數屬性

類型:ScopedItemOptions
預設值:None
接受的值:None, ReadOnly, Constant, Private, AllScope, Unspecified
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-PassThru

回傳一個代表新變數的物件。 根據預設，此 Cmdlet 不會產生任何輸出。

參數屬性

類型:SwitchParameter
預設值:False
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Scope

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

  • Global
  • Local
  • Script
  • Private
  • 相對於當前範圍的數字（0 減去範圍數，其中 0 是目前範圍，1 是其父範圍）。

Local 是預設值。

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

參數屬性

類型:String
預設值:Local
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Value

指定變數的值。

參數屬性

類型:Object
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:1
必要:False
來自管線的值:True
來自管線按屬性名稱的值:True
來自剩餘引數的值:False

-Visibility

判斷變數是否在建立時的會話之外可見。 此參數設計用於腳本與指令，並交付給其他使用者。

有效值為：

  • Public：變數是可見的。 （Public 是預設值。）
  • Private：變數不可見。

當變數是私有變數時，它不會出現在變數清單中，例如 由 Get-Variable回傳的變數，也不會出現在 變 數： 磁碟的顯示中。 讀取或更改私有變數值的指令會回傳錯誤。 然而，使用者可以執行使用私有變數的指令，前提是這些指令是在該變數定義的會話中寫入的。

參數屬性

類型:SessionStateEntryVisibility
預設值:Public
接受的值:Public, Private
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-WhatIf

顯示 Cmdlet 執行時會發生什麼事。 指令未執行。

參數屬性

類型:SwitchParameter
預設值:False
支援萬用字元:False
不要顯示:False
別名:威斯康辛

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

CommonParameters

此 cmdlet 支援常見參數：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 如需詳細資訊，請參閱 about_CommonParameters。

輸入

Object

Value 參數接受從管線輸入的物件，無論是來自具有 Value 屬性的物件。

String

Name 參數接受具有 Name 屬性的管線物件的字串輸入。

輸出

None

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

PSVariable

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

備註

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

  • 所有平臺：
    • set
    • sv