Clear-ItemProperty

SYNOPSIS

Deletes the value of a property but it does not delete the property.

SYNTAX

Clear-ItemProperty [-path] <string[]> [-name] <string> [-force] [-include <string[]>] [-exclude <string[]>] [-filter <string>] [-passThru] [-credential <PSCredential>] [-whatIf] [-confirm] [<CommonParameters>]

Clear-ItemProperty [-literalPath] <string[]> [-name] <string> [-force] [-include <string[]>] [-exclude <string[]>] [-filter <string>] [-passThru] [-credential <PSCredential>] [-whatIf] [-confirm] [<CommonParameters>]

DETAILED DESCRIPTION

The Clear-ItemProperty cmdlet deletes 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

-path <string[]>

Specifies the path to the property being cleared. Wildcards are permitted.

Required?	true
Position?	1
Default value	N/A - The path must be specified
Accept pipeline input?	true (ByValue, ByPropertyName)
Accept wildcard characters?	true

-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?	2
Default value	String.empty
Accept pipeline input?	true (ByPropertyName)
Accept wildcard characters?	true

-force <SwitchParameter>

Overrides restrictions that prevent the command from succeeding, just so the changes do not compromise security. For example, Force will override the read-only attribute or create directories to complete a file path, but it will not attempt to change file permissions.

Required?	false
Position?	named
Default value
Accept pipeline input?	false
Accept wildcard characters?	false

-include <string[]>

Clears only the specified items. 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
Accept pipeline input?	false
Accept wildcard characters?	true

-exclude <string[]>

Omits the specified items. 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
Accept pipeline input?	false
Accept wildcard characters?	true

-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 retrieving the objects, rather than having Windows PowerShell filter the objects after they are retrieved.

Required?	false
Position?	named
Default value
Accept pipeline input?	false
Accept wildcard characters?	false

-passThru <SwitchParameter>

Passes the object created by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.

Required?	false
Position?	named
Default value	False
Accept pipeline input?	false
Accept wildcard characters?	false

-credential <PSCredential>

Uses a credential to validate access to the file. <Credential> represents a user-name, such as "User01" or "Domain01\User01", or a PSCredential object, such as the one retrieved by using the Get-Credential cmdlet. If you type a user name, you will be prompted for a password. This parameter appears, but it is not supported in any Windows PowerShell core cmdlets or providers.

Required?	false
Position?	named
Default value
Accept pipeline input?	true (ByPropertyName)
Accept wildcard characters?	false

-literalPath <string[]>

Specifies the path to the property being cleared. Unlike Path, 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?	1
Default value
Accept pipeline input?	true (ByPropertyName)
Accept wildcard characters?	false

-whatIf

Describes what would happen if you executed the command without actually executing the command.

Required?	false
Position?	named
Default value
Accept pipeline input?	false
Accept wildcard characters?	false

-confirm

Prompts you for confirmation before executing the command.

Required?	false
Position?	named
Default value
Accept pipeline input?	false
Accept wildcard characters?	false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

NOTES

For more information, type "Get-Help Clear-ItemProperty -detailed". For technical information, type "Get-Help Clear-ItemProperty -full".

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.

When specifying multiple values for a parameter, use commas to separate the values. For example, "<parameter-name> <value1>, <value2>".

You can also refer to Clear-ItemProperty by its built-in alias, "clp". For more information, see About_Alias.

EXAMPLE 1

clear-itemproperty -path HKLM:\Software\MyCompany\MyApp -name Options

This command deletes 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