New-ItemProperty
为项创建新属性并设置该属性的值。
语法
New-ItemProperty
[-Path] <String[]>
[-Name] <String>
[-PropertyType <String>]
[-Value <Object>]
[-Force]
[-Filter <String>]
[-Include <String[]>]
[-Exclude <String[]>]
[-Credential <PSCredential>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
New-ItemProperty
-LiteralPath <String[]>
[-Name] <String>
[-PropertyType <String>]
[-Value <Object>]
[-Force]
[-Filter <String>]
[-Include <String[]>]
[-Exclude <String[]>]
[-Credential <PSCredential>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
说明
cmdlet New-ItemProperty
为指定项创建新属性并设置其值。
此 cmdlet 通常用于创建新注册表值,因为注册表值是注册表项的属性。
此 cmdlet 不能向对象添加属性。
- 若要将属性添加到对象的实例,请使用
Add-Member
cmdlet。 - 若要向特定类型的所有对象添加属性,请修改 Types.ps1xml 文件。
示例
示例 1:添加注册表项
此命令将新的注册表项 NoOfEmployees
添加到 MyCompany
的 HKLM:\Software hive
键。
第一个命令使用 Path 参数指定注册表项的路径 MyCompany
。
它使用 Name 参数指定条目的名称,使用 Value 参数指定其值。
第二个命令使用 Get-ItemProperty
cmdlet 查看新的注册表项。
New-ItemProperty -Path "HKLM:\Software\MyCompany" -Name "NoOfEmployees" -Value 822
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
示例 2:将注册表项添加到键
此命令向注册表项添加新的注册表条目。 为了指定键,它使用管道运算符 (|
) 将表示密钥的对象发送到 New-ItemProperty
。
命令的第一部分使用 Get-Item
cmdlet 获取 MyCompany
注册表项。 管道运算符将命令 New-ItemProperty
的结果发送到 ,后者将新的注册表项 () NoOfLocations
及其值 (3
) 添加到 MyCompany
项。
Get-Item -Path "HKLM:\Software\MyCompany" | New-ItemProperty -Name NoOfLocations -Value 3
此命令之所以有效,是因为 PowerShell 的参数绑定功能将返回 的 RegistryKey 对象的 Get-Item
路径与 的New-ItemProperty
LiteralPath 参数相关联。 有关详细信息,请参阅 about_Pipelines。
示例 3:使用 Here-String 在注册表中Create MultiString 值
此示例使用 Here-String 创建 MultiString
值。
$newValue = New-ItemProperty -Path "HKLM:\SOFTWARE\ContosoCompany\" -Name 'HereString' -PropertyType MultiString -Value @"
This is text which contains newlines
It can also contain "quoted" strings
"@
$newValue.multistring
This is text which contains newlines
It can also contain "quoted" strings
示例 4:使用数组在注册表中Create MultiString 值
该示例演示如何使用值数组创建 MultiString
值。
$newValue = New-ItemProperty -Path "HKLM:\SOFTWARE\ContosoCompany\" -Name 'MultiString' -PropertyType MultiString -Value ('a','b','c')
$newValue.multistring[0]
a
参数
-Confirm
提示你在运行 cmdlet 之前进行确认。
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Credential
指定有权执行此操作的用户帐户。 默认为当前用户。
键入用户名(如 User01
或 Domain01\User01
),或输入 PSCredential 对象,例如 cmdlet Get-Credential
生成的用户名。 如果键入用户名,则将提示你输入密码。
注意
随 PowerShell 一起安装的任何提供程序都不支持此参数。 若要模拟其他用户,或在运行此 cmdlet 时提升凭据,请使用 Invoke-Command。
Type: | PSCredential |
Position: | Named |
Default value: | Current user |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Exclude
指定此 cmdlet 在操作中排除的一个或多个项作为字符串数组。 此参数值使 Path 参数有效。 请输入路径元素或模式,例如 *.txt
。 允许使用通配符。 仅当命令包含项的内容(例如 C:\Windows\*
),其中通配符指定目录的内容C:\Windows
时,Exclude 参数才有效。
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | True |
-Filter
指定筛选器以限定 Path 参数。 FileSystem 提供程序是支持使用筛选器的唯一已安装 PowerShell 提供程序。 可以在 about_Wildcards 中找到 FileSystem 筛选器语言的语法。 筛选器比其他参数更有效,因为提供程序在 cmdlet 获取对象时应用它们,而不是在检索对象后让 PowerShell 筛选对象。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | True |
-Force
强制 cmdlet 创建用户非此不能访问的对象的属性。 不同提供程序有不同的实现。 有关详细信息,请参阅 about_Providers。
Type: | SwitchParameter |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Include
指定此 cmdlet 将在操作中包含的一个项或多个项(作为一个字符串数组)。 此参数值使 Path 参数有效。 请输入路径元素或模式,例如 *.txt
。 允许使用通配符。 仅当命令包含项的内容(例如 C:\Windows\*
),其中通配符指定目录的内容C:\Windows
时,Include 参数才有效。
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | True |
-LiteralPath
指定一个或多个位置的路径。 LiteralPath 的值完全按照键入的方式使用。 不会将任何字符解释为通配符。 如果路径包含转义字符,请将其括在单引号 ('
) 。 单引号告知 PowerShell 不要将任何字符解释为转义序列。
有关详细信息,请参阅 about_Quoting_Rules。
Type: | String[] |
Aliases: | PSPath, LP |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Name
指定新属性的名称。 如果该属性是注册表条目,则此参数指定该条目的名称。
Type: | String |
Aliases: | PSProperty |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Path
指定项的路径。 允许使用通配符。 此参数标识此 cmdlet 要向其添加新属性的项。
Type: | String[] |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | True |
-PropertyType
这是 注册表 提供程序提供的动态参数。 注册表提供程序和此参数仅在 Windows 上可用。
指定此 cmdlet 添加的属性类型。 此参数的可接受值为:
String
:指定以 null 结尾的字符串。 用于 REG_SZ 值。ExpandString
:指定以 null 结尾的字符串,该字符串包含对检索值时展开的环境变量的未扩展引用。 用于 REG_EXPAND_SZ 值。Binary
:指定任何格式的二进制数据。 用于 REG_BINARY 值。DWord
:指定 32 位二进制数。 用于 REG_DWORD 值。MultiString
:指定以两个 null 字符结尾的以 null 结尾的字符串数组。 用于 REG_MULTI_SZ 值。Qword
:指定 64 位二进制数。 用于 REG_QWORD 值。Unknown
:指示不受支持的注册表数据类型,例如 REG_RESOURCE_LIST 值。
Type: | RegistryValueKind |
Aliases: | Type |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Value
指定属性值。 如果该属性是注册表条目,则此参数指定该条目的值。
Type: | Object |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
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 |
输入
None
不能通过管道将对象传递给此 cmdlet。
输出
此 cmdlet 返回表示新属性的自定义对象。
备注
New-ItemProperty
旨在处理由任何提供程序公开的数据。 若要列出会话中可用的提供程序,请键入 Get-PSProvider
。 有关详细信息,请参阅 about_Providers。