New-ItemProperty
建立項目的新屬性並且設定項目的值。例如,您可以使用 New-ItemProperty 建立與變更登錄值和資料,這些內容都屬於登錄機碼的屬性。
語法
New-ItemProperty [-LiteralPath] <string[]> [-Name] <string> [-Credential <PSCredential>] [-Exclude <string[]>] [-Filter <string>] [-Force] [-Include <string[]>] [-PropertyType <string>] [-Value <Object>] [-Confirm] [-WhatIf] [-UseTransaction] [<CommonParameters>]
New-ItemProperty [-Path] <string[]> [-Name] <string> [-Credential <PSCredential>] [-Exclude <string[]>] [-Filter <string>] [-Force] [-Include <string[]>] [-PropertyType <string>] [-Value <Object>] [-Confirm] [-WhatIf] [-UseTransaction] [<CommonParameters>]
描述
New-ItemProperty Cmdlet 建立指定項目的新屬性並且設定項目的值。因為登錄值是登錄機碼項目的屬性,所以,一般而言,這個 Cmdlet 會用於建立新的登錄值。
此 Cmdlet 不會將屬性新增到物件。若要將屬性新增到物件的執行個體,請使用 Add-Member Cmdlet。若要將某一屬性新增到特定型別的所有物件,請編輯 Types.ps1xml 檔案。
參數
-Credential <PSCredential>
指定具有執行此動作之權限的使用者帳戶。預設為目前使用者。
請輸入使用者名稱,例如 "User01" 或 "Domain01\User01",或是輸入 PSCredential 物件,例如由 Get-Credential Cmdlet 所產生的物件。如果輸入使用者名稱,將會提示您提供密碼。
所有隨 Windows PowerShell 安裝的提供者都不支援此參數。
必要? |
false |
位置? |
named |
預設值 |
|
接受管線輸入? |
true (ByPropertyName) |
接受萬用字元? |
false |
-Exclude <string[]>
忽略指定的項目。允許使用萬用字元。
必要? |
false |
位置? |
named |
預設值 |
|
接受管線輸入? |
false |
接受萬用字元? |
false |
-Filter <string>
指定以提供者的格式或語言表示的篩選器。此參數的值用於限定 Path 參數。
篩選器的語法 (包括萬用字元的用法) 依提供者而定。篩選器比其他參數更有效率,因為提供者會在擷取物件時套用篩選器,而非等到 Windows PowerShell 擷取物件後才進行篩選。
必要? |
false |
位置? |
named |
預設值 |
|
接受管線輸入? |
false |
接受萬用字元? |
false |
-Force
允許此 Cmdlet 在使用者無法以其他方式存取的物件上建立屬性。實作因提供者而異。如需詳細資訊,請參閱 about_Providers。
必要? |
false |
位置? |
named |
預設值 |
|
接受管線輸入? |
false |
接受萬用字元? |
false |
-Include <string[]>
此參數的值用於限定 Path 參數。輸入路徑元素或模式,例如 "*.txt"。允許使用萬用字元。
必要? |
false |
位置? |
named |
預設值 |
|
接受管線輸入? |
false |
接受萬用字元? |
false |
-LiteralPath <string[]>
指定項目屬性的路徑。LiteralPath 係取用實際輸入的內容做為參數值。任何字元均不被解譯成萬用字元。如果路徑中包含逸出字元,請將其置於單引號內。單引號係告訴 Windows PowerShell 不要將任何字元解譯成逸出序列。
必要? |
true |
位置? |
1 |
預設值 |
|
接受管線輸入? |
true (ByPropertyName) |
接受萬用字元? |
false |
-Name <string>
指定新屬性的名稱。如果該屬性為登錄項目,則這個參數會指定項目的名稱。
必要? |
true |
位置? |
2 |
預設值 |
|
接受管線輸入? |
true (ByPropertyName) |
接受萬用字元? |
false |
-Path <string[]>
指定項目的路徑。這個參數會識別要加入新屬性的目的項目。
必要? |
true |
位置? |
1 |
預設值 |
|
接受管線輸入? |
false |
接受萬用字元? |
false |
-PropertyType <string>
指定要新增的屬性類型。
必要? |
false |
位置? |
named |
預設值 |
|
接受管線輸入? |
true (ByPropertyName) |
接受萬用字元? |
false |
-Value <Object>
指定屬性值。如果該屬性為登錄項目,則這個參數會指定項目的值。
必要? |
false |
位置? |
named |
預設值 |
|
接受管線輸入? |
true (ByPropertyName) |
接受萬用字元? |
false |
-Confirm
在執行命令前先提示確認。
必要? |
false |
位置? |
named |
預設值 |
|
接受管線輸入? |
false |
接受萬用字元? |
false |
-WhatIf
說明執行命令時將會發生何種情況,但不會實際執行命令。
必要? |
false |
位置? |
named |
預設值 |
|
接受管線輸入? |
false |
接受萬用字元? |
false |
-UseTransaction
將命令加入現用交易中。此參數只有當交易進行中時才有效。如需詳細資訊,請參閱 about_Transactions。
必要? |
false |
位置? |
named |
預設值 |
|
接受管線輸入? |
false |
接受萬用字元? |
false |
<CommonParameters>
這個 Cmdlet 支援一般參數:-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer 和 -OutVariable。如需詳細資訊,請參閱 about_Commonparameters.
輸入和輸出
輸入型別是可經由管道輸出至 Cmdlet 的物件型別。傳回型別則是 Cmdlet 所傳回的物件型別。
輸入 |
無 您無法經由管道將輸入輸出至 New-ItemProperty。 |
輸出 |
System.Management.Automation.PSCustomObject New-ItemProperty 會傳回包含新屬性的自訂物件。 |
附註
New-ItemProperty Cmdlet 設計的用意是要操作任一提供者所公開的資料。若要列出可在工作階段中使用的提供者,請輸入 "Get-PSProvider"。如需詳細資訊,請參閱 about_Providers。
範例 1
C:\PS>new-itemproperty -path HKLM:\Software\MyCompany -name NoOfEmployees -value 822
C:\PS> get-itemproperty hklm:\software\mycompany
PSPath : Microsoft.PowerShell.Core\Registry::HKEY_LOCAL_MACHINE\software\mycompany
PSParentPath : Microsoft.PowerShell.Core\Registry::HKEY_LOCAL_MACHINE\software
PSChildName : mycompany
PSDrive : HKLM
PSProvider : Microsoft.PowerShell.Core\Registry
NoOfLocations : 2
NoOfEmployees : 822
描述
-----------
這個命令會將 NoOfEmployees 這個新登錄項目加入 HKLM:\Software Hive 的 MyCompany 機碼。
第一個命令使用 Path 參數指定 MyCompany 登錄機碼的路徑。該命令使用 Name 參數指定項目的名稱,並且使用 Value 參數指定項目的值。
第二個命令使用 Get-ItemProperty Cmdlet 檢視新登錄項目。
範例 2
C:\PS>get-item -path HKLM:\Software\MyCompany | new-Itemproperty -name NoOfLocations -value 3
描述
-----------
這個命令會將新登錄項目加入登錄機碼。這個命令會使用管線運算子 (|),將表示機碼的物件傳送到 New-ItemProperty Cmdlet 以指定機碼。
命令的第一個部分使用 Get-Item Cmdlet 取得 MyCompany 登錄機碼。管線運算子 (|) 將命令的結果傳送到 New-ItemProperty Cmdlet,該 Cmdlet 會將新的登錄項目、NoOfLocations 以及項目值 3 新增到 MyCompany 機碼。
由於 Windows PowerShell 的參數繫結功能會與 RegistryKey 物件 (Get-Item 隨 New-ItemProperty 的 LiteralPath 參數所傳回) 的路徑建立關聯,所以這個命令能夠發生作用。如需詳細資訊,請參閱 about_Pipelines。
請參閱
概念
about_Providers
Clear-ItemProperty
Copy-ItemProperty
Move-ItemProperty
Rename-ItemProperty
Get-ItemProperty
Set-ItemProperty
Remove-ItemProperty