Set-ItemProperty

参考

模块:: Microsoft.PowerShell.Management

创建或更改项的属性的值。

语法

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

Set-ItemProperty
   [-Path] <String[]>
   -InputObject <PSObject>
   [-PassThru]
   [-Force]
   [-Filter <String>]
   [-Include <String[]>]
   [-Exclude <String[]>]
   [-Credential <PSCredential>]
   [-WhatIf]
   [-Confirm]
   [-UseTransaction]
   [<CommonParameters>]

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

Set-ItemProperty
   -LiteralPath <String[]>
   -InputObject <PSObject>
   [-PassThru]
   [-Force]
   [-Filter <String>]
   [-Include <String[]>]
   [-Exclude <String[]>]
   [-Credential <PSCredential>]
   [-WhatIf]
   [-Confirm]
   [-UseTransaction]
   [<CommonParameters>]

说明

Set-ItemProperty cmdlet 更改指定项的属性的值。可以使用 cmdlet 来建立或更改项的属性。例如，可以使用 Set-ItemProperty 将文件对象的 IsReadOnly 属性的值设置为 $True。

还可以使用 Set-ItemProperty 创建和更改注册表值和数据。例如，可以将新的注册表项添加到某个键，并建立或更改其值。

示例

示例 1：设置文件的属性

此命令将“final.doc”文件的 IsReadOnly 属性的值设置为“true”。它使用 Path 来指定文件，Name 指定属性的名称，Value 参数指定新值。

该文件是 System.IO.FileInfo 对象，IsReadOnly 只是其属性之一。若要查看所有属性，请键入 Get-Item C:\GroupFiles\final.doc | Get-Member -MemberType Property。

$true 自动变量表示值为“TRUE”。有关详细信息，请参阅 about_Automatic_Variables。

Set-ItemProperty -Path C:\GroupFiles\final.doc -Name IsReadOnly -Value $true

示例 2：创建注册表项和值

此示例演示如何使用 Set-ItemProperty 创建新的注册表项，并为该条目分配值。它在“HKLM\Software”键的“ContosoCompany”键中创建“NoOfEmployees”条目，并将其值设置为 823。

由于注册表项被视为注册表项的属性（即项），因此使用 Set-ItemProperty 创建注册表项，以及建立和更改其值。

第一个命令创建注册表项。它使用 Path 指定 HKLM: 驱动器的路径和“Software\MyCompany”密钥。该命令使用名称指定条目名称和值指定值。

第二个命令使用 Get-ItemProperty cmdlet 查看新的注册表项。如果使用 Get-Item 或 Get-ChildItem cmdlet，则不会显示这些条目，因为它们是键的属性，而不是项或子项。

第三个命令将 NoOfEmployees 条目的值更改为 824。

还可以使用 New-ItemProperty cmdlet 创建注册表项及其值，然后使用 Set-ItemProperty 更改值。

有关 HKLM: 驱动器的详细信息，请键入 Get-Help Get-PSDrive。有关如何使用 PowerShell 管理注册表的详细信息，请键入 Get-Help Registry。

Set-ItemProperty -Path "HKLM:\Software\ContosoCompany" -Name "NoOfEmployees" -Value 823
Get-ItemProperty -Path "HKLM:\Software\ContosoCompany"

PSPath        : Microsoft.PowerShell.Core\Registry::HKEY_LOCAL_MACHINE\software\contosocompany
PSParentPath  : Microsoft.PowerShell.Core\Registry::HKEY_LOCAL_MACHINE\software
PSChildName   : contosocompany
PSDrive       : HKLM
PSProvider    : Microsoft.PowerShell.Core\Registry
NoOfLocations : 2
NoOfEmployees : 823

Set-ItemProperty -Path "HKLM:\Software\ContosoCompany" -Name "NoOfEmployees" -Value 824
Get-ItemProperty -Path "HKLM:\Software\ContosoCompany"

PSPath        : Microsoft.PowerShell.Core\Registry::HKEY_LOCAL_MACHINE\software\contosocompany
PSParentPath  : Microsoft.PowerShell.Core\Registry::HKEY_LOCAL_MACHINE\software
PSChildName   : contosocompany
PSDrive       : HKLM
PSProvider    : Microsoft.PowerShell.Core\Registry
NoOfLocations : 2
NoOfEmployees : 824

示例 3：使用管道修改项

这些命令演示如何使用管道运算符（|）将项发送到 Set-ItemProperty。

该命令的第一部分使用 Get-ChildItem 获取表示“Weekly.txt”文件的对象。该命令使用管道运算符将文件对象发送到 Set-ItemProperty。 Set-ItemProperty 命令使用 Name 和 Value 参数来指定属性及其新值。

此命令等效于使用 InputObject 参数指定 Get-ChildItem 获取的对象。

Get-ChildItem weekly.txt | Set-ItemProperty -Name IsReadOnly -Value $True

参数

-Confirm

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

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

-Credential

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

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

警告

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

类型:	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
接受通配符:	True

-Force

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

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

-Include

仅指定 cmdlet 对其执行操作的那些项，这将排除所有其他项。此参数的值限定 Path 参数。输入路径元素或模式，例如“*.txt”。允许使用通配符。

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

-InputObject

指定具有此 cmdlet 更改的属性的对象。输入包含对象或获取对象的命令的变量。

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

-LiteralPath

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

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

-Name

指定属性的名称。

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

-PassThru

返回一个表示项属性的对象。默认情况下，此 cmdlet 不生成任何输出。

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

-Path

指定要修改的属性的项的路径。

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

-UseTransaction

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

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

-Value

指定属性的值。

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

-WhatIf

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

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

输入

PSObject

可以通过管道将对象传递给此 cmdlet。

输出

None, System.Management.Automation.PSCustomObject

如果指定 PassThru 参数，则此 cmdlet 将生成 PSCustomObject 对象，该对象表示已更改的项及其新属性值。否则，此 cmdlet 不会生成任何输出。

备注

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

通过