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]
   [<CommonParameters>]
New-ItemProperty
   -LiteralPath <String[]>
   [-Name] <String>
   [-PropertyType <String>]
   [-Value <Object>]
   [-Force]
   [-Filter <String>]
   [-Include <String[]>]
   [-Exclude <String[]>]
   [-Credential <PSCredential>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

说明

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

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

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

示例

示例 1：添加注册表项

此命令向 HKLM:\Software hive 的 MyCompany 键添加新的注册表条目 NoOfEmployees。

第一个条命令使用 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 的参数绑定功能将 Get-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 之前进行确认。

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Credential

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

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

注意

随同 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

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

输出

PSCustomObject

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

备注

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