powershellscripts.com

Tutorials  PowerShell Cmdlet Help for Clear-ItemProperty



NAME
Clear-ItemProperty

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

SYNTAX
Clear-ItemProperty [-LiteralPath] [-Name] [-Credential ] [-Exclude ] [-
Filter ] [-Force] [-Include ] [-PassThru] [-Confirm] [-WhatIf] [-UseTransaction] [ rs>]

Clear-ItemProperty [-Path] [-Name] [-Credential ] [-Exclude ] [-Filter
] [-Force] [-Include ] [-PassThru] [-Confirm] [-WhatIf] [-UseTransaction] []


DESCRIPTION
The Clear-ItemProperty cmdlet deletes the value of a property, but it does not delete the property. You can use thi
s cmdlet to delete the data from a registry value.


PARAMETERS
-Credential
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
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-Exclude
Omits the specified items. The value of this parameter qualifies the Path parameter. Enter a path element or pa
ttern, such as "*.txt" or "s*". Wildcards are permitted.

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

-Filter
Specifies a filter in the provider's format or language. The value of this parameter qualifies the Path paramet
er. The syntax of the filter, including the use of wildcards, depends on the provider. Filters are more efficie
nt than other parameters, because the provider applies them when retrieving the objects rather than having Wind
ows PowerShell filter the objects after they are retrieved.

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

-Force []
Allows the cmdlet to delete properties from items that cannot otherwise be accessed by the user. Implementatio
n varies from provider to provider. For more information, see about_Providers.

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

-Include
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? false

-LiteralPath
Specifies the path to the property being cleared. Unlike Path, the value of LiteralPath is used exactly as it i
s typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in sing
le quotation marks. Single quotation marks tell Windows PowerShell not to interpret any characters as escape se
quences.

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

-Name
Specifies the name of the property to be cleared, such as the name of a registry value. Wildcards are not permi
tted.

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

-PassThru []
Returns an object representing the cleared item's property. By default, this cmdlet does not generate any outpu
t.

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

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

Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
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

-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

-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.

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


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

INPUTS
System.String
You can pipe a path string to Clear-ItemProperty.


OUTPUTS
None or System.Management.Automation.PSCustomObject
When you use the PassThru parameter, Clear-ItemProperty generates a PSCustomObject object that represents the c
leared 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 ty
pe 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 --------------------------

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


Description
-----------
This command deletes the data in the Options registry value in the MyApp subkey of HKEY_LOCAL_MACHINE\Software\MyCo
mpany.

Because the command is being issued from a file system drive (C:), it uses the fully qualified path to the HKLM: dr
ive 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=113284
about_Providers
Copy-ItemProperty
New-ItemProperty
Move-ItemProperty
Rename-ItemProperty
Get-ItemProperty
New-ItemProperty