Set-Item

將項目的值更改為指令中指定的值。

語法

Path (Default) - All providers

Set-Item
    [-Path] <String[]>
    [[-Value] <Object>]
    [-Force]
    [-PassThru]
    [-Filter <String>]
    [-Include <String[]>]
    [-Exclude <String[]>]
    [-Credential <PSCredential>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

LiteralPath - All providers

Set-Item
    [[-Value] <Object>]
    -LiteralPath <String[]>
    [-Force]
    [-PassThru]
    [-Filter <String>]
    [-Include <String[]>]
    [-Exclude <String[]>]
    [-Credential <PSCredential>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Path (Default) - Alias and Function providers

Set-Item
    [-Path] <string[]>
    [[-Value] <Object>]
    [-Force]
    [-PassThru]
    [-Filter <string>]
    [-Include <string[]>]
    [-Exclude <string[]>]
    [-Credential <pscredential>]
    [-WhatIf]
    [-Confirm]
    [-Options <ScopedItemOptions>]
    [<CommonParameters>]

LiteralPath - Alias and Function providers

Set-Item
    [[-Value] <Object>]
    -LiteralPath <string[]>
    [-Force]
    [-PassThru]
    [-Filter <string>]
    [-Include <string[]>]
    [-Exclude <string[]>]
    [-Credential <pscredential>]
    [-WhatIf]
    [-Confirm]
    [-Options <ScopedItemOptions>]
    [<CommonParameters>]

Path (Default) - Registry provider

Set-Item
    [-Path] <string[]>
    [[-Value] <Object>]
    [-Force]
    [-PassThru]
    [-Filter <string>]
    [-Include <string[]>]
    [-Exclude <string[]>]
    [-Credential <pscredential>]
    [-WhatIf]
    [-Confirm]
    [-Type <RegistryValueKind>]
    [<CommonParameters>]

LiteralPath - Registry provider

Set-Item
    [[-Value] <Object>]
    -LiteralPath <string[]>
    [-Force]
    [-PassThru]
    [-Filter <string>]
    [-Include <string[]>]
    [-Exclude <string[]>]
    [-Credential <pscredential>]
    [-WhatIf]
    [-Confirm]
    [-Type <RegistryValueKind>]
    [<CommonParameters>]

Description

Set-Item指令本會將項目(如變數或登錄檔鍵)的值更改為指令中指定的值。

範例

範例 1:建立別名

此指令為記事本建立 np 別名。

Set-Item -Path Alias:np -Value "C:\windows\notepad.exe"

範例 2:變更環境變數的值

此指令會將 UserRole 環境變數的值改為 Administrator。

Set-Item -Path Env:UserRole -Value "Administrator"

範例 3:修改你的提示函式

此指令會改變提示功能,使其顯示路徑前的時間。

Set-Item -Path Function:prompt -Value {
    'PS '+ (Get-Date -Format t) + " " + (Get-Location) + '> '
}

範例 4:為你的提示函式設定選項

此指令設定提示功能中的 AllScope 與 ReadOnly 選項。 此指令使用選項動態參數。Set-Item 選項參數僅在你與Set-Item或函數提供者一起使用時才會使用。

Set-Item -Path Function:prompt -Options "AllScope,ReadOnly"

參數

-Confirm

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

參數屬性

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

參數集

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

-Credential

Note

任何與 PowerShell 一起安裝的提供者都不支援此參數。 若要模擬其他使用者,或在執行此 Cmdlet 時提升您的認證,請使用 Invoke-Command。

參數屬性

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

參數集

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

-Exclude

指定要在此 Cmdlet 作業中排除的項目或多項,並以字串陣列形式表示。 此參數的值對 路徑 參數進行限定。 輸入路徑元素或模式,例如 *.txt。 允許使用通配符字元。 只有在命令包含項目的內容,例如 時,C:\Windows\* 參數才有效,其中通配符會指定 C:\Windows 目錄的內容。

參數屬性

類型:

String[]

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

參數集

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

-Filter

指定篩選條件,以限定 Path 參數。 FileSystem 提供者是唯一已安裝且支援使用篩選的 PowerShell 提供者。 您可以在 about_Wildcards中找到 FileSystem 篩選語言的語法。 篩選比其他參數更有效率,因為提供者會在 Cmdlet 取得物件時套用它們,而不是在擷取對象之後讓 PowerShell 篩選物件。

參數屬性

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

參數集

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

-Force

強制 cmdlet 設定無法更改的項目,例如唯讀別名或變數。 指令小程式無法更改常數別名或變數。 實作會因提供者而異。 如需詳細資訊,請參閱 about_Providers。 即使使用 Force 參數,指令長也無法覆蓋安全限制。

參數屬性

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

參數集

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

-Include

指定此 Cmdlet 在操作中包含的一個或多個專案,這些專案是以字串陣列的形式表示。 此參數的值對 路徑 參數進行限定。 輸入路徑元素或模式,例如 "*.txt"。 允許使用通配符字元。 只有當命令包含項目的內容,例如 時,C:\Windows\* 參數才有效,其中通配符會指定 C:\Windows 目錄的內容。

參數屬性

類型:

String[]

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

參數集

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

-LiteralPath

指定通往一個或多個位置的路徑。 LiteralPath 的值會按原本輸入的方式使用。 不會將任何字元解譯為通配符。 如果路徑包含逸出字元,請以單引弧括住它。 單引號會告知PowerShell不要將任何字元解譯為逸出序列。

如需詳細資訊,請參閱 about_Quoting_Rules。

參數屬性

類型:

String[]

預設值:None
支援萬用字元:False
不要顯示:False
別名:PSPath, LP

參數集

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

-Options

這是由 別名 與 函式 提供者提供的動態參數。 欲了解更多資訊,請參閱 about_Alias_Provider 與 about_Function_Provider。

指定別名的 Options 屬性值。

有效值為:

  • None:別名沒有條件約束(預設值)
  • ReadOnly:可以刪除別名,但無法使用 Force 參數來變更
  • Constant:無法刪除或變更別名
  • Private:別名只能在目前的範圍內使用
  • AllScope:別名會自動複製到任何新建立的範圍中
  • Unspecified:未指定選項

參數屬性

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

參數集

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

-PassThru

將代表該項目的物件傳遞給管線。 根據預設,此 Cmdlet 不會產生任何輸出。

參數屬性

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

參數集

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

-Path

指定物品位置的路徑。 允許使用通配符字元。

參數屬性

類型:

String[]

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

參數集

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

-Type

這是由 登錄檔 提供者提供的動態參數。 Registry提供者及此參數僅在 Windows 上提供。

指定此 cmdlet 所新增的屬性類型。 此參數可接受的值為:

  • String: 指定一個空終端字串。 用於 REG_SZ 數值。
  • ExpandString: 指定一個空終止字串,包含未展開的環境變數參考,當取回該值時會展開。 用於 REG_EXPAND_SZ 數值。
  • Binary: 指定任何形式的二進位資料。 用於 REG_BINARY 數值。
  • DWord: 指定一個 32 位元的二進位數。 用於 REG_DWORD 數值。
  • MultiString: 指定一個由兩個空字元結尾的空終止字串陣列。 用於 REG_MULTI_SZ 數值。
  • Qword: 指定一個 64 位元的二進位數。 用於 REG_QWORD 數值。
  • Unknown表示不支援的登錄資料型態,例如 REG_RESOURCE_LIST 值。

參數屬性

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

參數集

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

-Value

指定該物品的新值。

參數屬性

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

參數集

(All)
Position:1
必要:False
來自管線的值:True
來自管線按屬性名稱的值:True
來自剩餘引數的值: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

你可以將代表新項目值的物件管道傳送到這個 cmdlet。

輸出

None

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

Object

當你使用 PassThru 參數時,這個 cmdlet 會回傳一個代表該物品的物件。

備註

PowerShell 包含下列 Set-Item的別名:

  • 所有平臺:

    • si
  • Set-Item PowerShell 檔案系統提供者不支援。 要更改檔案系統中項目的值,請使用 Set-Content cmdlet。

  • 在登錄檔磁碟機中, HKLM: 且 HKCU:會 Set-Item 改變登錄檔鍵的(預設)值資料。

    • 要建立和更改登錄檔鍵的名稱,請使用 New-Item 和 Rename-Item cmdlet。
    • 若要更改登錄檔值中的名稱與資料,請使用 New-ItemProperty、 Set-ItemProperty和 Rename-ItemProperty cmdlet。
  • Set-Item 的設計目的是要處理任何提供者所公開的數據。 若要列出工作階段中可用的提供者,請輸入 Get-PSProvider。 如需詳細資訊,請參閱 about_Providers。