Windows PowerShell command on Get-command Remove-ItemProperty

NAME

Remove-ItemProperty

SYNOPSIS

Deletes the property and its value from an item.

SYNTAX

Remove-ItemProperty [-Name] [-Confirm] [-Credential ] [-Exclude ] [-Filter

] [-Force] [-Include ] -LiteralPath [-UseTransaction] [-WhatIf] []

Remove-ItemProperty [-Path] [-Name] [-Confirm] [-Credential ] [-Exclude

] [-Filter ] [-Force] [-Include ] [-UseTransaction] [-WhatIf] []

DESCRIPTION

The Remove-ItemProperty cmdlet deletes a property and its value from an item. You can use it to delete registry

values and the data that they store.

PARAMETERS

-Confirm []

Prompts you for confirmation before running the cmdlet. Required? false Position? named Default value False Accept pipeline input? False Accept wildcard characters? false

-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, this cmdlet prompts you 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

Specifies items that this cmdlet omits. The value of this parameter qualifies the Path parameter. Enter a path

element or pattern, such as *.txt. Wildcard characters are permitted.

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

-Filter

Specifies a filter in the format or language of the provider. The value of this parameter qualifies the Path parameter. The syntax of the filter, including the use of wildcard characters, depends on the provider. Filters are more efficient than other parameters, because the provider applies them when it retrieves the objects instead of 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 []

Forces the cmdlet to remove a property of an object 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

Specifies items to delete. The value of this parameter qualifies the Path parameter. Enter a path element or

pattern, such as *.txt. Wildcard characters are permitted.

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

-LiteralPath

Specifies a path of the item property. The value of the LiteralPath parameter is used exactly as it is typed. No characters are interpreted as wildcard characters. 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

Specifies the names of the properties to remove. Required? true Position? 1 Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false

-Path

Specifies the path of the item whose properties are being removed. Wildcard characters are permitted. Required? true Position? 0 Default value None

Accept pipeline input? True (ByPropertyName, ByValue)

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 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 []

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 This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

System.String You can pipe a string that contains a path, but not a literal path, to this cmdlet.

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_Aliases. 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. Remove-ItemProperty

* 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: Delete a registry value

PS C:\>Remove-ItemProperty -Path "HKLM:\Software\SmpApplication" -Name "SmpProperty"

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 (PS C:\>), it includes the fully qualified path of the

SmpApplication 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: Delete a registry value from the HKCU location

PS C:\>Set-Location HKCU:\Software\MyCompany\MyApp

PS HKCU:\Software\MyCompany\MyApp> Remove-ItemProperty -Path . -Name "Options" -Confirm

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 Remove-ItemProperty to remove the Options registry value, and its data, from the MyApp

subkey. Because Path is required, the command uses a dot (.) to indicate the current location. It uses Name to

specify which registry value to delete. It uses the Confirm parameter to request a user prompt before deleting the value.

Example 3: Remove a registry value by using the pipeline

PS C:\>Get-Item -Path HKLM:\Software\MyCompany | Remove-ItemProperty -Name NoOfEmployees

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 Remove-ItemProperty . Then, it uses the Name parameter of Remove-ItemProperty to specify

the name of the registry value.