New-ItemProperty
SYNOPSIS
Sets a new property of an item at a location.
SYNTAX
New-ItemProperty [-path] <string[]> [-name] <string> [-propertyType <string>] [-value <Object>] [-include <string[]>] [-exclude <string[]>] [-filter <string>] [-force] [-credential <PSCredential>] [-whatIf] [-confirm] [<CommonParameters>]
New-ItemProperty [-literalPath] <string[]> [-name] <string> [-propertyType <string>] [-value <Object>] [-include <string[]>] [-exclude <string[]>] [-filter <string>] [-force] [-credential <PSCredential>] [-whatIf] [-confirm] [<Com
monParameters>]
DETAILED DESCRIPTION
Sets a new property of an item at a location.
PARAMETERS
-path <string[]>
The path of the item for which a new property is to be created.
Required? |
true |
Position? |
1 |
Default value |
N/A - The path must be specified |
Accept pipeline input? |
false |
Accept wildcard characters? |
true |
-name <string>
The name of the property to be created.
Required? |
true |
Position? |
2 |
Default value |
String.empty |
Accept pipeline input? |
true (ByPropertyName) |
Accept wildcard characters? |
false |
-propertyType <string>
The Type of the property.
Required? |
false |
Position? |
named |
Default value |
String.empty |
Accept pipeline input? |
true (ByPropertyName) |
Accept wildcard characters? |
false |
-value <Object>
The Value of the property.
Required? |
false |
Position? |
named |
Default value |
String.empty |
Accept pipeline input? |
true (ByPropertyName) |
Accept wildcard characters? |
false |
-include <string[]>
Specifies only those items upon which the cmdlet will act, excluding all others.
Required? |
false |
Position? |
named |
Default value |
|
Accept pipeline input? |
false |
Accept wildcard characters? |
true |
-exclude <string[]>
Omits the specified items. Wildcards are permitted.
Required? |
false |
Position? |
named |
Default value |
|
Accept pipeline input? |
false |
Accept wildcard characters? |
true |
-filter <string>
Specifies filter elements as required and supported by providers.
Required? |
false |
Position? |
named |
Default value |
|
Accept pipeline input? |
false |
Accept wildcard characters? |
false |
-force <SwitchParameter>
Allows the cmdlet to override restrictions such as renaming existing files as long as security is not compromised.
Required? |
false |
Position? |
named |
Default value |
False |
Accept pipeline input? |
false |
Accept wildcard characters? |
false |
-credential <PSCredential>
The credential is used to validate access. If a PSCredential object, obtained earlier using get-credential is supplied, it will be used as is. If a user name is supplied, there will be a prompt for a password.
Required? |
false |
Position? |
named |
Default value |
|
Accept pipeline input? |
true (ByPropertyName) |
Accept wildcard characters? |
false |
-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
Object
NOTES
For more information, type "Get-Help New-ItemProperty -detailed". For technical information, type "Get-Help New-ItemProperty -full".
When specifying multiple values for a parameter, use commas to separate the values. For example, "<parameter-name> <value1>, <value2>".
EXAMPLE 1
new-itemproperty SmpApplication -name config -Type int -Value 1
This example assumes working in the Registry namespace where there is a store for a "SmpApplication" under "HKLM:\Software". In the store there is a new int property named "Exp".
RELATED LINKS