New-ItemProperty

模块:

Microsoft.PowerShell.Management

为项创建新属性并设置其值。

语法

New-ItemProperty
   [-Path] <String[]>
   [-Name] <String>
   [-PropertyType <String>]
   [-Value <Object>]
   [-Force]
   [-Filter <String>]
   [-Include <String[]>]
   [-Exclude <String[]>]
   [-Credential <PSCredential>]
   [-WhatIf]
   [-Confirm]
   [-UseTransaction]
   [<CommonParameters>]

New-ItemProperty
   -LiteralPath <String[]>
   [-Name] <String>
   [-PropertyType <String>]
   [-Value <Object>]
   [-Force]
   [-Filter <String>]
   [-Include <String[]>]
   [-Exclude <String[]>]
   [-Credential <PSCredential>]
   [-WhatIf]
   [-Confirm]
   [-UseTransaction]
   [<CommonParameters>]

说明

New-ItemProperty cmdlet 为指定项创建新属性并设置其值。 通常，此 cmdlet 用于创建新的注册表值，因为注册表值是注册表项项的属性。

此 cmdlet 不会向对象添加属性。

• 若要将属性添加到对象的实例，请使用 Add-Member cmdlet。
• 若要向特定类型的所有对象添加属性，请修改 Types.ps1xml 文件。

示例

示例 1：添加注册表项

此命令将新的注册表项 NoOfEmployees添加到 HKLM:\Software hive的 MyCompany 键。

第一个命令使用 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

此命令的工作原理是 Windows PowerShell 的参数绑定功能将 Get-ItemGet-Item 返回的 RegistryKey 对象的路径与 New-ItemProperty的 LiteralPath 参数相关联。 有关详细信息，请参阅 about_Pipelines。

示例 3：使用 Here-String 在注册表中创建 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：使用数组在注册表中创建 MultiString 值

该示例演示如何使用值数组来创建 MultiString 值。

$newValue = New-ItemProperty -Path "HKLM:\SOFTWARE\ContosoCompany\" -Name 'MultiString' -PropertyType MultiString -Value ('a','b','c')
$newValue.multistring[0]

a

参数

-Confirm

在运行 cmdlet 之前，提示你进行确认。

类型:	SwitchParameter
别名:	cf
Position:	Named
默认值:	False
必需:	False
接受管道输入:	False
接受通配符:	False

-Credential

指定有权执行此作的用户帐户。 默认值为当前用户。

键入用户名（如 User01 或 Domain01\User01），或输入 PSCredential 对象，例如由 Get-Credential cmdlet 生成的用户名。 如果键入用户名，系统会提示输入密码。

注意

任何随 PowerShell 一起安装的提供程序都不支持此参数。 若要模拟其他用户，或在运行此 cmdlet 时提升凭据，请使用 Invoke-Command。

类型:	PSCredential
Position:	Named
默认值:	Current user
必需:	False
接受管道输入:	True
接受通配符:	False

-Exclude

指定此 cmdlet 从作中排除的属性或属性作为字符串数组。 此参数的值限定 Path 参数。 输入路径元素或模式，例如 *.txt。 允许使用通配符。

类型:	String[]
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-Filter

以提供程序的格式或语言指定筛选器。 此参数的值限定 Path 参数。

筛选器的语法（包括通配符的使用）取决于提供程序。 筛选器比其他参数更有效，因为提供程序在 cmdlet 获取对象时应用它们，而不是在检索对象后让 PowerShell 筛选对象。

类型:	String
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-Force

强制 cmdlet 在用户无法访问的对象上创建属性。 实现因提供程序而异。 有关详细信息，请参阅 about_Providers。

类型:	SwitchParameter
Position:	Named
默认值:	False
必需:	False
接受管道输入:	False
接受通配符:	False

-Include

指定此 cmdlet 包含在作中的项（作为字符串数组）。 此参数的值限定 Path 参数。 输入路径元素或模式，例如 *.txt。 允许使用通配符。 仅当命令包含项的内容（如 C:\Windows\*）时，Include 参数才有效，其中通配符指定 C:\Windows 目录的内容。

类型:	String[]
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-LiteralPath

指定一个或多个位置的路径。 LiteralPath 的值与类型化完全相同。 不会将任何字符解释为通配符。 如果路径包含转义字符，请将它括在单引号（'）。 单引号告知 PowerShell 不要将任何字符解释为转义序列。

有关详细信息，请参阅 about_Quoting_Rules。

类型:	String[]
别名:	PSPath
Position:	Named
默认值:	None
必需:	True
接受管道输入:	True
接受通配符:	False

-Name

指定新属性的名称。 如果该属性是注册表项，则此参数指定该条目的名称。

类型:	String
别名:	PSProperty
Position:	1
默认值:	None
必需:	True
接受管道输入:	True
接受通配符:	False

-Path

指定项的路径。 此参数标识此 cmdlet 向其添加新属性的项。

类型:	String[]
Position:	0
默认值:	None
必需:	True
接受管道输入:	False
接受通配符:	False

-PropertyType

指定此 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 值。

类型:	String
别名:	Type
Position:	Named
默认值:	None
必需:	False
接受管道输入:	True
接受通配符:	False

-UseTransaction

在活动事务中包含该命令。 此参数仅在事务正在进行时有效。 有关详细信息，请参阅 about_Transactions。

类型:	SwitchParameter
别名:	usetx
Position:	Named
默认值:	False
必需:	False
接受管道输入:	False
接受通配符:	False

-Value

指定属性值。 如果该属性是注册表项，则此参数指定该条目的值。

类型:	Object
Position:	Named
默认值:	None
必需:	False
接受管道输入:	True
接受通配符:	False

-WhatIf

显示 cmdlet 运行时会发生什么情况。 cmdlet 未运行。

类型:	SwitchParameter
别名:	wi
Position:	Named
默认值:	False
必需:	False
接受管道输入:	False
接受通配符:	False

输入

None

不能通过管道将对象传递给此 cmdlet。

输出

PSCustomObject

此 cmdlet 返回一个表示新属性的自定义对象。

备注

New-ItemProperty 旨在处理任何提供程序公开的数据。 若要列出会话中可用的提供程序，请键入 Get-PSProvider。 有关详细信息，请参阅 about_Providers。

相关链接

• Clear-ItemProperty
• Copy-ItemProperty
• Get-ItemProperty
• Move-ItemProperty
• Remove-ItemProperty
• Rename-ItemProperty
• Set-ItemProperty
• about_Providers