Clear-Item
Clears the contents of an item, but does not delete the item.
语法
Path （默认值）
Clear-Item
[-Path] <String[]>
[-Force]
[-Filter <String>]
[-Include <String[]>]
[-Exclude <String[]>]
[-Credential <PSCredential>]
[-WhatIf]
[-Confirm]
[-UseTransaction]
[<CommonParameters>]
LiteralPath
Clear-Item
-LiteralPath <String[]>
[-Force]
[-Filter <String>]
[-Include <String[]>]
[-Exclude <String[]>]
[-Credential <PSCredential>]
[-WhatIf]
[-Confirm]
[-UseTransaction]
[<CommonParameters>]
说明
The Clear-Item cmdlet clears the content of an item, but it does not delete the item.
For example, the Clear-Item cmdlet can delete the value of a variable, but it does not delete the
variable. The value that used to represent a cleared item is defined by each PowerShell provider.
This cmdlet is similar to Clear-Content, but it works on aliases and variables, instead of files.
示例
Example 1: Clear the value of a variable
This command clears the value of the variable named TestVar1.
The variable remains and is valid, but its value is set to $null.
The variable name is prefixed with Variable: to indicate the PowerShell Variable provider.
The alternate commands show that, to get the same result, you can switch to the PowerShell Variable: drive and then run the Clear-Item command.
Clear-Item Variable:TestVar1
Set-Location Variable:
PS Variable:\> Clear-Item TestVar1
Example 2: Clear all registry entries
This command clears all registry entries in the "MyKey" subkey, but only after prompting you to confirm your intent. It does not delete the "MyKey" subkey or affect any other registry keys or entries. You can use the Include and Exclude parameters to identify particular registry keys, but you cannot use them to identify registry entries.
- To delete particular registry entries, use the
Remove-ItemPropertycmdlet. - To delete the value of a registry entry, use the
Clear-ItemPropertycmdlet.
Clear-Item HKLM:\Software\MyCompany\MyKey -Confirm
参数
-Confirm
Prompts you for confirmation before running the cmdlet.
参数属性
| 类型: | SwitchParameter |
| 默认值: | False |
| 支持通配符: | False |
| 不显示: | False |
| 别名: | cf |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-Credential
Note
This parameter is not supported by any providers installed with PowerShell. To impersonate another user, or elevate your credentials when running this cmdlet, use Invoke-Command.
参数属性
| 类型: | PSCredential |
| 默认值: | Current user |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | True |
| 来自剩余参数的值: | False |
-Exclude
Specifies, as a string array, an item or items that this cmdlet excludes in the operation. The value
of this parameter qualifies the Path parameter. Enter a path element or pattern, such as
*.txt. Wildcard characters are permitted. The Exclude parameter is effective only when the
command includes the contents of an item, such as C:\Windows\*, where the wildcard character
specifies the contents of the C:\Windows directory.
参数属性
| 类型: | String[] |
| 默认值: | None |
| 支持通配符: | True |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-Filter
Specifies a filter to qualify the Path parameter. The FileSystem provider is the only installed PowerShell provider that supports the use of filters. You can find the syntax for the FileSystem filter language in about_Wildcards. Filters are more efficient than other parameters, because the provider applies them when the cmdlet gets the objects rather than having PowerShell filter the objects after they are retrieved.
参数属性
| 类型: | String |
| 默认值: | None |
| 支持通配符: | True |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-Force
Indicates that the cmdlet clears items that cannot otherwise be changed, such as read- only aliases. The cmdlet cannot clear constants. Implementation varies from provider to provider. For more information, see about_Providers. The cmdlet cannot override security restrictions, even when the Force parameter is used.
参数属性
| 类型: | SwitchParameter |
| 默认值: | False |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-Include
Specifies, as a string array, an item or items that this cmdlet includes in the operation. The value
of this parameter qualifies the Path parameter. Enter a path element or pattern, such as
"*.txt". Wildcard characters are permitted. The Include parameter is effective only when the
command includes the contents of an item, such as C:\Windows\*, where the wildcard character
specifies the contents of the C:\Windows directory.
参数属性
| 类型: | String[] |
| 默认值: | None |
| 支持通配符: | True |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-LiteralPath
Specifies a path to one or more locations. The value of LiteralPath is used exactly as it is typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences.
For more information, see about_Quoting_Rules.
参数属性
| 类型: | String[] |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
| 别名: | PSPath |
参数集
LiteralPath
| Position: | Named |
| 必需: | True |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | True |
| 来自剩余参数的值: | False |
-Path
Specifies the path to the items being cleared. Wildcard characters are permitted. This parameter is required, but the parameter name Path is optional.
参数属性
| 类型: | String[] |
| 默认值: | None |
| 支持通配符: | True |
| 不显示: | False |
参数集
Path
| Position: | 0 |
| 必需: | True |
| 来自管道的值: | True |
| 来自管道的值（按属性名称）: | True |
| 来自剩余参数的值: | False |
-UseTransaction
Includes the command in the active transaction. This parameter is valid only when a transaction is in progress. For more information, see about_Transactions.
参数属性
| 类型: | SwitchParameter |
| 默认值: | False |
| 支持通配符: | False |
| 不显示: | False |
| 别名: | usetx |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
参数属性
| 类型: | SwitchParameter |
| 默认值: | False |
| 支持通配符: | False |
| 不显示: | False |
| 别名: | wi |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
输入
String
You can pipe a path string to this cmdlet.
输出
None
This cmdlet does not generate any output.
备注
- The
Clear-Itemcmdlet is supported only by several PowerShell providers, including the Alias, Environment, Function, Registry, and Variable providers. As such, you can useClear-Itemto delete the content of items in the provider namespaces. To list the providers available in your session, typeGet-PsProvider. For more information, see about_Providers. - You cannot use
Clear-Itemto delete the contents of a file, because the PowerShell FileSystem provider does not support this cmdlet. To clear files, use theClear-Content.