New-ItemProperty

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

语法

Path (默认值)

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

LiteralPath

New-ItemProperty
    [-Name] <String>
    -LiteralPath <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 的参数绑定功能将 RegistryKey 返回的 Get-Item 对象的路径与 New-ItemProperty 参数相关联。 有关详细信息,请参阅 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
默认值:False
支持通配符:False
不显示:False
别名:cf

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Credential

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

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

警告

随 Windows PowerShell 一起安装的任何提供程序都不支持此参数。

参数属性

类型:PSCredential
默认值:Current user
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):True
来自剩余参数的值:False

-Exclude

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

参数属性

类型:

String[]

默认值:None
支持通配符:True
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Filter

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

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

参数属性

类型:String
默认值:None
支持通配符:True
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Force

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

参数属性

类型:SwitchParameter
默认值:False
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Include

指定一个或多个此 cmdlet 在操作中包含的项,这些项以字符串数组形式表示。 此参数的值定义了 Path 参数的限定条件。 输入路径元素或模式,例如“*.txt”。 允许使用通配符。

参数属性

类型:

String[]

默认值:None
支持通配符:True
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-LiteralPath

指定此属性的当前位置的路径。 与 Path 参数不同,LiteralPath 的值与键入时完全相同。 不会将任何字符解释为通配符。 如果路径包含转义字符,请将它括在单引号中。 单引号告知 PowerShell 不要将任何字符解释为转义序列。

参数属性

类型:

String[]

默认值:None
支持通配符:False
不显示:False
别名:PSPath

参数集

LiteralPath
Position:Named
必需:True
来自管道的值:False
来自管道的值(按属性名称):True
来自剩余参数的值:False

-Name

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

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False
别名:PSProperty

参数集

(All)
Position:1
必需:True
来自管道的值:False
来自管道的值(按属性名称):True
来自剩余参数的值:False

-Path

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

参数属性

类型:

String[]

默认值:None
支持通配符:False
不显示:False

参数集

Path
Position:0
必需:True
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-PropertyType

指定此 cmdlet 添加的属性的类型。 此参数的可接受值为:

  • 字符串:指定以 null 结尾的字符串。 等效于 REG_SZ
  • ExpandString:指定一个以 null 结尾的字符串,该字符串包含对检索值时展开的环境变量的未扩展引用。 等效于 REG_EXPAND_SZ
  • 二进制:以任何形式指定二进制数据。 等效于 REG_BINARY
  • DWord:指定 32 位二进制数。 等效于 REG_DWORD
  • MultiString:指定以两个 null 字符结尾的以 null 结尾的字符串数组。 等效于 REG_MULTI_SZ
  • Qword:指定 64 位二进制数。 等效于 REG_QWORD
  • 未知:指示不支持的注册表数据类型,例如 REG_RESOURCE_LIST

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False
别名:类型

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):True
来自剩余参数的值:False

-UseTransaction

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

参数属性

类型:SwitchParameter
默认值:False
支持通配符:False
不显示:False
别名:usetx

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Value

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

参数属性

类型:Object
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):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

输入

None

不能通过管道将输入传递给此 cmdlet。

输出

PSCustomObject

New-ItemProperty 返回包含新属性的自定义对象。

备注

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