Set-ItemProperty
创建或更改某一项的属性值。
语法
Set-ItemProperty
[-Path] <string[]>
[-Name] <string>
[-Value] <Object>
[-PassThru]
[-Force]
[-Filter <string>]
[-Include <string[]>]
[-Exclude <string[]>]
[-Credential <pscredential>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-ItemProperty
[-Path] <string[]>
-InputObject <psobject>
[-PassThru]
[-Force]
[-Filter <string>]
[-Include <string[]>]
[-Exclude <string[]>]
[-Credential <pscredential>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-ItemProperty
[-Name] <string>
[-Value] <Object>
-LiteralPath <string[]>
[-PassThru]
[-Force]
[-Filter <string>]
[-Include <string[]>]
[-Exclude <string[]>]
[-Credential <pscredential>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-ItemProperty
-LiteralPath <string[]>
-InputObject <psobject>
[-PassThru]
[-Force]
[-Filter <string>]
[-Include <string[]>]
[-Exclude <string[]>]
[-Credential <pscredential>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-ItemProperty
[-Path] <string[]>
[-Name] <string>
[-Value] <Object>
[-PassThru]
[-Force]
[-Filter <string>]
[-Include <string[]>]
[-Exclude <string[]>]
[-Credential <pscredential>]
[-WhatIf]
[-Confirm]
[-Type <RegistryValueKind>]
[<CommonParameters>]
Set-ItemProperty
[-Path] <string[]>
-InputObject <psobject>
[-PassThru]
[-Force]
[-Filter <string>]
[-Include <string[]>]
[-Exclude <string[]>]
[-Credential <pscredential>]
[-WhatIf]
[-Confirm]
[-Type <RegistryValueKind>]
[<CommonParameters>]
Set-ItemProperty
[-Name] <string>
[-Value] <Object>
-LiteralPath <string[]>
[-PassThru]
[-Force]
[-Filter <string>]
[-Include <string[]>]
[-Exclude <string[]>]
[-Credential <pscredential>]
[-WhatIf]
[-Confirm]
[-Type <RegistryValueKind>]
[<CommonParameters>]
Set-ItemProperty
-LiteralPath <string[]>
-InputObject <psobject>
[-PassThru]
[-Force]
[-Filter <string>]
[-Include <string[]>]
[-Exclude <string[]>]
[-Credential <pscredential>]
[-WhatIf]
[-Confirm]
[-Type <RegistryValueKind>]
[<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
创建新的注册表项以及为条目赋值。 它在 key 中的“ContosoCompany”键 HKLM\Software
中创建“NoOfEmployees”条目,并将其值设置为 823。
由于注册表项被视为注册表项的属性(即项),因此使用 Set-ItemProperty
创建注册表项,以及建立和更改其值。
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
第一个命令创建注册表项。
它使用 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
。
示例 3:使用管道修改项
此示例使用 Get-ChildItem
获取 weekly.txt
文件。 文件对象通过管道传递给 Set-ItemProperty
。 该 Set-ItemProperty
命令使用 Name 和 Value 参数指定属性及其新值。
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
注意
随 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 |
-InputObject
指定具有此 cmdlet 更改的属性的对象。 请输入包含对象的变量或可获取该对象的命令。
Type: | PSObject |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-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 |
-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: | True |
-Type
这是 注册表 提供程序提供的动态参数。 注册表提供程序和此参数仅在 Windows 上可用。
指定此 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: | RegistryValueKind |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
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
默认情况下,此 cmdlet 不返回任何输出。
使用 PassThru 参数时,此 cmdlet 返回一个 PSCustomObject 对象,该对象表示已更改的项及其新属性值。
备注
PowerShell 包含以下别名 Set-ItemProperty
:
- 所有平台:
sp
Set-ItemProperty
旨在处理由任何提供程序公开的数据。 若要列出会话中可用的提供程序,请键入 Get-PSProvider
。 有关详细信息,请参阅 about_Providers。