powershellscripts.com

Tutorials  PowerShell Cmdlet Help for Remove-ItemProperty



NAME
Remove-ItemProperty

SYNOPSIS
Deletes the property and its value from an item.

SYNTAX
Remove-ItemProperty [-LiteralPath] [-Name] [-Credential ] [-Exclude ]
[-Filter ] [-Force] [-Include ] [-Confirm] [-WhatIf] [-UseTransaction] []

Remove-ItemProperty [-Path] [-Name] [-Credential ] [-Exclude ] [-Filt
er ] [-Force] [-Include ] [-Confirm] [-WhatIf] [-UseTransaction] []


DESCRIPTION
The Remove-ItemProperty cmdlet deletes a property and its value from an item. You can use it to delete registry val
ues and the data that they store.


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". 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 remove a property of an object that cannot otherwise be accessed by the user. Implementati
on 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
Deletes only the specified items. The value of this parameter qualifies the Path parameter. Enter a path elemen
t or pattern, such as "*.txt". Wildcards are permitted.

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

-LiteralPath
Specifies a path to the item property. The value of LiteralPath is used exactly as it is typed. No characters a
re interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Sing
le 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

-Name
Specifies the names of the properties to be retrieved.

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

-Path
Specifies the path to the item whose properties are being removed. 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 string that contains a path (but not a literal path) to Remove-ItemProperty.


OUTPUTS
None
This cmdlet does not return any output.


NOTES


You can also refer to Remove-ItemProperty by its built-in alias, "rp". For more information, see about_Alias.

In the Windows PowerShell Registry provider, registry values are considered to be properties of a registry key
or subkey. You can use the ItemProperty cmdlets to manage these values.

The Remove-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>remove-itemproperty -path HKLM:\Software\SmpApplication -name SmpProperty


Description
-----------
This command deletes the SmpProperty registry value, and its data, from the SmpApplication subkey of the HKEY_LOCAL
_MACHINE\Software registry key.

Because the command is issued from a file system drive (C:\PS>), it includes the fully qualified path to the SmpApp
lication subkey, including the drive, HKLM:, and the Software key.

It uses the Name parameter to identify the registry value that is being deleted.





-------------------------- EXAMPLE 2 --------------------------

C:\PS>set-location HKCU:\Software\MyCompany\MyApp

PS HKCU:\Software\MyCompany\MyApp> remove-itemproperty -path . -Name Options -confirm


Description
-----------
These commands delete the Options registry value, and its data, from the MyApp subkey of HKEY_CURRENT_USER\Software
\MyCompany.

The first command uses the Set-Location cmdlet to change the current location to the HKEY_CURRENT_USER drive (HKCU:
) and the Software\MyCompany\MyApp subkey.

The second command uses the Remove-Item cmdlet to remove the Options registry value, and its data, from the MyApp s
ubkey. Because the Path parameter is required, the command uses a dot (.) to indicate the current location. It uses
the Name parameter to specify which registry value to delete. It uses the Confirm parameter to request a user prom
pt before deleting the value.





-------------------------- EXAMPLE 3 --------------------------

C:\PS>get-item -path HKLM:\Software\MyCompany | remove-itemproperty -name NoOfEmployees


Description
-----------
This command deletes the NoOfEmployees registry value, and its data, from the HKLM\Software\MyCompany registry key.


The command uses the Get-Item cmdlet to get an item that represents the registry key. It uses a pipeline operator (
|) to send the object to the Remove-ItemProperty cmdlet. Then, it uses the Name parameter of Remove-ItemProperty to
specify the name of the registry value.






RELATED LINKS
Online version: http://go.microsoft.com/fwlink/?LinkID=113374
about_Providers
Clear-ItemProperty
Copy-ItemProperty
Get-ItemProperty
Move-ItemProperty
New-ItemProperty
Remove-Item
Rename-ItemProperty
Set-ItemProperty