Clear-ItemProperty

  • 参考
模块:
Microsoft.PowerShell.Management

清除属性的值，但不删除该属性。

语法

Clear-ItemProperty
     [-Path] <String[]>
     [-Name] <String>
     [-PassThru]
     [-Force]
     [-Filter <String>]
     [-Include <String[]>]
     [-Exclude <String[]>]
     [-Credential <PSCredential>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]
Clear-ItemProperty
     -LiteralPath <String[]>
     [-Name] <String>
     [-PassThru]
     [-Force]
     [-Filter <String>]
     [-Include <String[]>]
     [-Exclude <String[]>]
     [-Credential <PSCredential>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

说明

Clear-ItemProperty cmdlet 清除属性的值，但不会删除该属性。 可以使用此 cmdlet 从注册表值中删除数据。

示例

示例 1：清除注册表项的值

此命令清除 HKEY_LOCAL_MACHINE\Software\MyCompany 的“MyApp”子项的“Options”注册表值中的数据。

Clear-ItemProperty -Path "HKLM:\Software\MyCompany\MyApp" -Name "Options"

参数

-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

-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
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:True

-PassThru

返回一个代表你所处理的项目的对象。 默认情况下，此 cmdlet 将不产生任何输出。

Type:SwitchParameter
Position:Named
Default value:False
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

-WhatIf

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

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

输入

String

可以通过管道将路径字符串传递给此 cmdlet。

输出

None

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

PSCustomObject

如果使用 PassThru 参数，则此 cmdlet 返回一个 PSCustomObject 对象，该对象表示已清除的项属性。

备注

PowerShell 包含以下 Clear-ItemProperty 别名：

  • 所有平台：

    • clp

  • 可以使用 Clear-ItemProperty 来删除注册表值中的数据，而不会删除该值。 如果该值的数据类型为 二进制 或 DWORD，则清除数据会将该值设置为零。 否则，该值为空。

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