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]
   [<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>]

说明

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 来创建注册表条目，并设定和更改它们的值。

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 之前进行确认。

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

-Credential

注意

随同 PowerShell 一起安装的任何提供程序都不支持此参数。 要模拟其他用户，或在运行此 cmdlet 时提升凭据，请使用 Invoke-Command。

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

-Exclude

以字符串数组的形式指定此 cmdlet 将在操作中排除的项。 此参数值使 Path 参数有效。 请输入路径元素或模式，例如 *.txt。 允许使用通配符。 仅当该命令包括项的内容时（例如 C:\Windows\*，其中通配符指定 C:\Windows 目录的内容），Exclude 参数才有效。

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

-Filter

指定用于限定 Path 参数的筛选器。 FileSystem 提供程序是唯一支持使用筛选器的已安装 PowerShell 提供程序。 可以在 about_Wildcards 中找到 FileSystem 筛选器语言的语法。 筛选器比其他参数更有效，因为提供程序是在 cmdlet 获取对象时应用筛选器，而不是在检索对象后再让 PowerShell 筛选对象。

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

-Force

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

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

-Include

指定此 cmdlet 将在操作中包含的一个项或多个项（作为一个字符串数组）。 此参数值使 Path 参数有效。 请输入路径元素或模式，例如 "*.txt"。 允许使用通配符。 仅当该命令包括项的内容时（例如 C:\Windows\*，其中通配符指定 C:\Windows 目录的内容），Include 参数才有效。

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

-InputObject

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

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

-LiteralPath

指定一个或多个位置的路径。 LiteralPath 的值严格按照所键入的形式使用。 不会将任何字符解释为通配符。 如果路径包括转义符，请将其括在单引号中。 单引号告知 PowerShell 不要将任何字符解释为转义序列。

有关详细信息，请参阅 about_Quoting_Rules。

类型:	String[]
别名:	PSPath, LP
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
接受通配符:	True

-Type

这是 Registry 提供程序提供的动态参数。 Registry 提供程序和此参数仅在 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 值。

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

-Value

指定属性的值。

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

-WhatIf

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

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

输入

PSObject

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

输出

None

默认情况下，此 cmdlet 不返回任何输出。

PSCustomObject

如果使用 PassThru 参数，则此 cmdlet 会返回一个 PSCustomObject 对象，该对象表示已更改的项及其新属性值。

备注

PowerShell 包含 Set-ItemProperty 的以下别名：

• 所有平台：
  • sp

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

相关链接

• Clear-ItemProperty
• Copy-ItemProperty
• Get-ItemProperty
• Move-ItemProperty
• New-ItemProperty
• Remove-ItemProperty
• Rename-ItemProperty
• about_Providers