Remove-ItemProperty
SYNOPSIS
Deletes the property and its value from an item.
SYNTAX
Remove-ItemProperty [-path] <string[]> [-name] <string[]> [-include <string[]>] [-force] [-exclude <string[]>] [-credential <PSCredential>] [-filter <string>] [-whatIf] [-confirm] [<CommonParameters>]
Remove-ItemProperty [-literalPath] <string[]> [-name] <string[]> [-include <string[]>] [-force] [-exclude <string[]>] [-credential <PSCredential>] [-filter <string>] [-whatIf] [-confirm] [<CommonParameters>]
DETAILED DESCRIPTION
The Remove-ItemProperty cmdlet deletes a property and its value from a item. You can use it to delete registry values and the data that they store.
PARAMETERS
-path <string[]>
Specifies the path to the item whose properties are being removed. 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 names of the properties to be retrieved.
Required? |
true |
Position? |
2 |
Default value |
String.empty |
Accept pipeline input? |
true (ByPropertyName) |
Accept wildcard characters? |
false |
-include <string[]>
Deletes 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 |
-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 |
False |
Accept pipeline input? |
false |
Accept wildcard characters? |
false |
-exclude <string[]>
Omits 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 |
-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 |
-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? |
true |
-literalPath <string[]>
Specifies a path to the item property. 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".
RETURN TYPE
None
NOTES
For more information, type "Get-Help Remove-ItemProperty -detailed". For technical information, type "Get-Help Remove-ItemProperty -full".
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.
When specifying multiple values for a parameter, use commas to separate the values. For example, "<parameter-name> <value1>, <value2>".
You can also refer to Remove-ItemProperty by its built-in alias, "rp". For more information, see About_Alias.
EXAMPLE 1
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 key. In the Windows PowerShell registry
Because the command is issued from a file system drive (C:\PS>), it includes the fully qualified path to 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
set-location HKCU:\Software\MyCompany\MyApp
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 the Remove-Item cmdlet to remove the Options registry value, and its data, from the MyApp subkey. 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 prompt before deleting the value.
RELATED LINKS
The server encountered an internal error or misconfiguration and was unable to complete your request.
Please contact the server administrator at webmaster@systemmanager.forsenergy.ru to inform them of the time this error occurred, and the actions you performed just before this error.
More information about this error may be available in the server error log.
Additionally, a 500 Internal Server Error error was encountered while trying to use an ErrorDocument to handle the request.