Clear-Item
清除项的内容,但不删除该项。
语法
Path (默认值)
Clear-Item
[-Path] <String[]>
[-Force]
[-Filter <String>]
[-Include <String[]>]
[-Exclude <String[]>]
[-Credential <PSCredential>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
LiteralPath
Clear-Item
-LiteralPath <String[]>
[-Force]
[-Filter <String>]
[-Include <String[]>]
[-Exclude <String[]>]
[-Credential <PSCredential>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
说明
Clear-Item
cmdlet 会清除项的内容,但不会删除该项。
例如,Clear-Item
cmdlet 可以删除变量的值,但不会删除变量。 用于表示清除项的值由每个 PowerShell 提供程序定义。
此 cmdlet 类似于 Clear-Content
,但它适用于别名和变量,而不是文件。
示例
示例 1:清除变量的值
此命令清除名为 TestVar1
的变量的值。
变量保持不变且有效,但其值设置为 $null
。
变量名称以 Variable:
为前缀,以指示 PowerShell 变量提供程序。
备用命令显示,若要获得相同的结果,可以切换到 PowerShell Variable:
驱动器,然后运行 Clear-Item
命令。
Clear-Item Variable:TestVar1
Set-Location Variable:
PS Variable:\> Clear-Item TestVar1
示例 2:清除所有注册表项
此命令清除“MyKey”子项中的所有注册表项,但仅在提示你确认意图之后。 它不会删除“MyKey”子项或影响任何其他注册表项或条目。 可以使用 包括 和 排除 参数来标识特定的注册表键,但不能使用它们来标识注册表项。
- 若要删除特定注册表项,请使用
Remove-ItemProperty
cmdlet。 - 若要删除注册表项的值,请使用
Clear-ItemProperty cmdlet
。
Clear-Item HKLM:\Software\MyCompany\MyKey -Confirm
参数
-Confirm
在运行 cmdlet 之前,提示你进行确认。
参数属性
类型: | SwitchParameter |
默认值: | False |
支持通配符: | False |
不显示: | False |
别名: | cf |
参数集
(All)
Position: | Named |
必需: | False |
来自管道的值: | False |
来自管道的值(按属性名称): | False |
来自剩余参数的值: | False |
-Credential
注释
任何随 PowerShell 一起安装的提供程序都不支持此参数。 要模拟其他用户,或在运行此 cmdlet 时提升凭据,请使用 Invoke-Command。
参数属性
类型: | PSCredential |
默认值: | Current user |
支持通配符: | False |
不显示: | False |
参数集
(All)
Position: | Named |
必需: | False |
来自管道的值: | False |
来自管道的值(按属性名称): | True |
来自剩余参数的值: | False |
-Exclude
指定一个或多个在操作中被此 cmdlet 排除的项目,以字符串数组的形式表示。 此参数的值定义了 Path 参数的限定条件。 输入路径元素或模式,例如 *.txt
。 允许使用通配符。 仅当命令包含项(如 )的内容(其中通配符指定 C:\Windows\*
目录的内容)时,C:\Windows
参数才有效。
参数属性
类型: | String[] |
默认值: | None |
支持通配符: | True |
不显示: | False |
参数集
(All)
Position: | Named |
必需: | False |
来自管道的值: | False |
来自管道的值(按属性名称): | False |
来自剩余参数的值: | False |
-Filter
指定筛选器以限定 Path 参数。 唯一支持使用筛选器的 PowerShell 提供程序是已安装的 FileSystem 提供程序。 可以在 about_Wildcards中找到 FileSystem 筛选器语言的语法。 筛选器比其他参数更有效,因为提供程序在 cmdlet 获取对象时应用它们,而不是在检索对象后让 PowerShell 筛选对象。
参数属性
类型: | String |
默认值: | None |
支持通配符: | True |
不显示: | False |
参数集
(All)
Position: | Named |
必需: | False |
来自管道的值: | False |
来自管道的值(按属性名称): | False |
来自剩余参数的值: | False |
-Force
指示 cmdlet 清除在其他情况下无法更改的项(如只读别名)。 cmdlet 无法清除常量。 实现因服务提供商而异。 有关详细信息,请参阅 about_Providers。 即使使用 Force 参数,cmdlet 也无法替代安全限制。
参数属性
类型: | SwitchParameter |
默认值: | False |
支持通配符: | False |
不显示: | False |
参数集
(All)
Position: | Named |
必需: | False |
来自管道的值: | False |
来自管道的值(按属性名称): | False |
来自剩余参数的值: | False |
-Include
指定一个或多个此 cmdlet 在操作中包含的项,这些项以字符串数组形式表示。 此参数的值定义了 Path 参数的限定条件。 输入路径元素或模式,例如 "*.txt"
。 允许使用通配符。 仅当命令包含某项的内容(例如 ,其中通配符指定 C:\Windows\*
目录的内容)时,C:\Windows
参数才有效。
参数属性
类型: | String[] |
默认值: | None |
支持通配符: | True |
不显示: | False |
参数集
(All)
Position: | Named |
必需: | False |
来自管道的值: | False |
来自管道的值(按属性名称): | False |
来自剩余参数的值: | False |
-LiteralPath
指定通向一个或多个位置的路径。 LiteralPath 的值严格按照所键入的形式使用。 不会将任何字符解释为通配符。 如果路径包含转义字符,请将它括在单引号中。 单引号告知 PowerShell 不要将任何字符解释为转义序列。
有关详细信息,请参阅 about_Quoting_Rules。
参数属性
类型: | String[] |
默认值: | None |
支持通配符: | False |
不显示: | False |
别名: | PSPath, LP |
参数集
LiteralPath
Position: | Named |
必需: | True |
来自管道的值: | False |
来自管道的值(按属性名称): | True |
来自剩余参数的值: | False |
-Path
指定要清除项的路径。 允许使用通配符。 此参数是必需的,但参数名称 路径 是可选的。
参数属性
类型: | String[] |
默认值: | None |
支持通配符: | True |
不显示: | False |
参数集
Path
Position: | 0 |
必需: | True |
来自管道的值: | True |
来自管道的值(按属性名称): | True |
来自剩余参数的值: | False |
-WhatIf
显示 cmdlet 运行时会发生什么情况。 命令脚本未运行。
参数属性
类型: | SwitchParameter |
默认值: | False |
支持通配符: | False |
不显示: | False |
别名: | 无线 |
参数集
(All)
Position: | Named |
必需: | False |
来自管道的值: | False |
来自管道的值(按属性名称): | False |
来自剩余参数的值: | False |
CommonParameters
此 cmdlet 支持通用参数:-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息,请参阅 about_CommonParameters。
输入
String
可以通过管道将路径字符串传递给此 cmdlet。
输出
None
此 cmdlet 不返回任何输出。
备注
PowerShell 包含以下与 Clear-Item
相关的别名:
所有平台:
cli
Clear-Item
cmdlet 仅受多个 PowerShell 提供程序的支持,包括 别名、环境、函数、注册表和 变量 提供程序。 因此,可以使用Clear-Item
删除提供者命名空间中项的内容。 若要列出会话中可用的提供程序,请键入Get-PSProvider
。 有关详细信息,请参阅 about_Providers。不能使用
Clear-Item
删除文件的内容,因为 PowerShell FileSystem 提供程序不支持此 cmdlet。 若要清除文件,请使用Clear-Content
。