< Back
Clear-ItemProperty
Post
NAME Clear-ItemProperty
SYNOPSIS
Clears the value of a property but does not delete the property.
SYNTAX
Clear-ItemProperty [-Name] <String> [-Confirm] [-Credential <PSCredential>] [-Exclude <String[]>] [-Filter <String>] [-Force] [-Include
<String[]>] -LiteralPath <String[]> [-PassThru] [-UseTransaction] [-WhatIf] [<CommonParameters>]
Clear-ItemProperty [-Path] <String[]> [-Name] <String> [-Confirm] [-Credential <PSCredential>] [-Exclude <String[]>] [-Filter <String>] [-Force]
[-Include <String[]>] [-PassThru] [-UseTransaction] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Clear-ItemProperty cmdlet clears the value of a property, but it does not delete the property. You can use this cmdlet to delete the data from
a registry value.
PARAMETERS
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Credential <PSCredential>
Specifies a user account that has permission to perform this action. The default is the current user.
Type a user name, such as User01 or Domain01\\User01, or enter a PSCredential object, such as one generated by the Get-Credential cmdlet. If
you type a user name, you will be prompted for a password.
This parameter is not supported by any providers installed with Windows PowerShell.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Exclude <String[]>
Specifies, as a string array, an item or items that this cmdlet excludes. The value of this parameter qualifies the Path parameter. Enter a
path element or pattern, such as .txt or s . Wildcards are permitted.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Filter <String>
Specifies a filter in the provider's format or language. The value of this parameter qualifies the Path parameter. The syntax of the filter,
including the use of wildcards, depends on the provider. Filters are more efficient than other parameters, because the provider applies them
when the cmdlet gets the objects rather than having Windows PowerShell filter the objects after they are retrieved.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Force [<SwitchParameter>]
Indicates that this cmdlet deletes properties from items that cannot otherwise be accessed by the user. Implementation varies from provider to
provider. For more information, see about_Providers.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Include <String[]>
Specifies, as a string array, an item or items that this cmdlet clears. The value of this parameter qualifies the Path parameter. Enter a path
element or pattern, such as *.txt. Wildcards are permitted.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-LiteralPath <String[]>
Specifies the path to the property being cleared. Unlike the Path parameter, 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 Windows PowerShell not to interpret any characters as escape sequences.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Name <String>
Specifies the name of the property to be cleared, such as the name of a registry value. Wildcards are not permitted.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Path <String[]>
Specifies the path to the property being cleared. Wildcards are permitted.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-UseTransaction [<SwitchParameter>]
Includes the command in the active transaction. This parameter is valid only when a transaction is in progress. For more information, see
Includes the command in the active transaction. This parameter is valid only when a transaction is in progress. For more information, see
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.String
You can pipe a path string to this cmdlet.
OUTPUTS
None or System.Management.Automation.PSCustomObject
When you use the PassThru parameter, Clear-ItemProperty generates a PSCustomObject object that represents the cleared item property.
Otherwise, this cmdlet does not generate any output.
NOTES
You can use Clear-ItemProperty * to delete the data in registry values without deleting the value. If the data type of the value is Binary or
DWORD, clearing the data sets the value to zero. Otherwise, the value is empty.
You can also refer to Clear-ItemProperty by its built-in alias, clp. For more information, see about_Aliases.
The Clear-ItemProperty cmdlet is designed to work with the data exposed by any provider. To list the providers available in your session, type
`Get-PSProvider`. For more information, see about_Providers.
*
Example 1: Clear the value of registry key
PS C:\\>Clear-ItemProperty -Path "HKLM:\\Software\\MyCompany\\MyApp" -Name "Options"
This command clear the data in the Options registry value in the MyApp subkey of HKEY_LOCAL_MACHINE\\Software\\MyCompany.
Because the command is being issued from a file system drive (C:), it uses the fully qualified path to the HKLM: drive and the
Software\\MyCompany\\MyApp subkey. It uses the Name parameter to specify the Options value.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=821570
Copy-ItemProperty
Get-ItemProperty
Move-ItemProperty
New-ItemProperty
Rename-ItemProperty
SYNOPSIS
Clears the value of a property but does not delete the property.
SYNTAX
Clear-ItemProperty [-Name] <String> [-Confirm] [-Credential <PSCredential>] [-Exclude <String[]>] [-Filter <String>] [-Force] [-Include
<String[]>] -LiteralPath <String[]> [-PassThru] [-UseTransaction] [-WhatIf] [<CommonParameters>]
Clear-ItemProperty [-Path] <String[]> [-Name] <String> [-Confirm] [-Credential <PSCredential>] [-Exclude <String[]>] [-Filter <String>] [-Force]
[-Include <String[]>] [-PassThru] [-UseTransaction] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Clear-ItemProperty cmdlet clears the value of a property, but it does not delete the property. You can use this cmdlet to delete the data from
a registry value.
PARAMETERS
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Credential <PSCredential>
Specifies a user account that has permission to perform this action. The default is the current user.
Type a user name, such as User01 or Domain01\\User01, or enter a PSCredential object, such as one generated by the Get-Credential cmdlet. If
you type a user name, you will be prompted for a password.
This parameter is not supported by any providers installed with Windows PowerShell.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Exclude <String[]>
Specifies, as a string array, an item or items that this cmdlet excludes. The value of this parameter qualifies the Path parameter. Enter a
path element or pattern, such as .txt or s . Wildcards are permitted.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Filter <String>
Specifies a filter in the provider's format or language. The value of this parameter qualifies the Path parameter. The syntax of the filter,
including the use of wildcards, depends on the provider. Filters are more efficient than other parameters, because the provider applies them
when the cmdlet gets the objects rather than having Windows PowerShell filter the objects after they are retrieved.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Force [<SwitchParameter>]
Indicates that this cmdlet deletes properties from items that cannot otherwise be accessed by the user. Implementation varies from provider to
provider. For more information, see about_Providers.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Include <String[]>
Specifies, as a string array, an item or items that this cmdlet clears. The value of this parameter qualifies the Path parameter. Enter a path
element or pattern, such as *.txt. Wildcards are permitted.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-LiteralPath <String[]>
Specifies the path to the property being cleared. Unlike the Path parameter, 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 Windows PowerShell not to interpret any characters as escape sequences.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Name <String>
Specifies the name of the property to be cleared, such as the name of a registry value. Wildcards are not permitted.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Path <String[]>
Specifies the path to the property being cleared. Wildcards are permitted.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-UseTransaction [<SwitchParameter>]
Includes the command in the active transaction. This parameter is valid only when a transaction is in progress. For more information, see
Includes the command in the active transaction. This parameter is valid only when a transaction is in progress. For more information, see
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.String
You can pipe a path string to this cmdlet.
OUTPUTS
None or System.Management.Automation.PSCustomObject
When you use the PassThru parameter, Clear-ItemProperty generates a PSCustomObject object that represents the cleared item property.
Otherwise, this cmdlet does not generate any output.
NOTES
You can use Clear-ItemProperty * to delete the data in registry values without deleting the value. If the data type of the value is Binary or
DWORD, clearing the data sets the value to zero. Otherwise, the value is empty.
You can also refer to Clear-ItemProperty by its built-in alias, clp. For more information, see about_Aliases.
The Clear-ItemProperty cmdlet is designed to work with the data exposed by any provider. To list the providers available in your session, type
`Get-PSProvider`. For more information, see about_Providers.
*
Example 1: Clear the value of registry key
PS C:\\>Clear-ItemProperty -Path "HKLM:\\Software\\MyCompany\\MyApp" -Name "Options"
This command clear the data in the Options registry value in the MyApp subkey of HKEY_LOCAL_MACHINE\\Software\\MyCompany.
Because the command is being issued from a file system drive (C:), it uses the fully qualified path to the HKLM: drive and the
Software\\MyCompany\\MyApp subkey. It uses the Name parameter to specify the Options value.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=821570
Copy-ItemProperty
Get-ItemProperty
Move-ItemProperty
New-ItemProperty
Rename-ItemProperty