Set-ItemProperty
创建或更改某一项的属性值。
语法
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>]
说明
cmdlet Set-ItemProperty
更改指定项的 属性的值。
可以使用该 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:Create注册表项和值
此示例演示如何使用 Set-ItemProperty
创建新的注册表项并将值分配给条目。
它在“HKLM\Software”键的“ContosoCompany”键中创建“NoOfEmployees”条目,并将其值设置为 823。
由于注册表项被视为注册表项的属性(即项),因此可以使用 Set-ItemProperty
创建注册表项以及建立和更改其值。
第一个命令创建注册表项。
它使用 Path 指定驱动器的路径 HKLM:
和“Software\MyCompany”密钥。
命令使用 Name 指定条目名称,使用 Value 指定值。
第二个命令使用 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 之前进行确认。
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 生成的一个 PSCredential 对象。
如果键入用户名,则将提示你输入密码。
警告
随同 Windows PowerShell 一起安装的任何提供程序都不支持此参数。
Type: | PSCredential |
Position: | Named |
Default value: | Current user |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Exclude
指定 cmdlet 不对其执行操作的项,并包括所有其他项。 此参数值使 Path 参数有效。 请输入路径元素或模式,例如“*.txt”。 允许使用通配符。
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Filter
以提供程序的格式或语言指定筛选器。 此参数值使 Path 参数有效。
筛选器的语法(包括通配符字符的使用),具体取决于提供程序。 筛选器比其他参数更高效,因为提供程序在 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”。 允许使用通配符。
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InputObject
指定具有此 cmdlet 更改的属性的对象。 请输入包含对象的变量或可获取该对象的命令。
Type: | PSObject |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-LiteralPath
指定项属性的路径。 与 Path 参数不同,LiteralPath 的值严格按照所键入的形式使用。 不会将任何字符解释为通配符。 如果路径包括转义符,请将其括在单引号中。 单引号告知 PowerShell 不要将任何字符解释为转义序列。
Type: | String[] |
Aliases: | PSPath |
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 |
-PassThru
返回一个对象,该对象表示项属性。 默认情况下,此 cmdlet 将不产生任何输出。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Path
指定要修改的 属性的项的路径。
Type: | String[] |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-UseTransaction
在活动事务中使用该命令。 仅当正在执行事务时,此参数才有效。 有关详细信息,请参阅 about_Transactions。
Type: | SwitchParameter |
Aliases: | usetx |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Value
指定属性的值。
Type: | Object |
Position: | 2 |
Default value: | None |
Required: | True |
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 |
输入
可以通过管道将对象传递给此 cmdlet。
输出
None, System.Management.Automation.PSCustomObject
如果指定 PassThru 参数,此 cmdlet 将生成一个 PSCustomObject 对象,该对象表示已更改的项及其新属性值。 否则,此 cmdlet 将不生成任何输出。
备注
Set-ItemProperty
旨在处理由任何提供程序公开的数据。 若要列出会话中可用的提供程序,请键入 Get-PSProvider
。 有关详细信息,请参阅 about_Providers。