Set-ItemProperty
SYNOPSIS
Sets the value of a property at the specified location.
SYNTAX
Set-ItemProperty [-path] <string[]> [-name] <string> [-value] <Object> [-include <string[]>] [-exclude <string[]>] [-filter <string>] [-force] [-passThru] [-credential <PSCredential>] [-whatIf] [-confirm] [<CommonParameters>]
Set-ItemProperty [-path] <string[]> -inputObject <psobject> [-include <string[]>] [-exclude <string[]>] [-filter <string>] [-force] [-passThru] [-credential <PSCredential>] [-whatIf] [-confirm] [<CommonParameters>]
Set-ItemProperty [-literalPath] <string[]> [-name] <string> [-value] <Object> [-include <string[]>] [-exclude <string[]>] [-filter <string>] [-force] [-passThru] [-credential <PSCredential>] [-whatIf] [-confirm] [<CommonParameters
>]
Set-ItemProperty [-literalPath] <string[]> -inputObject <psobject> [-include <string[]>] [-exclude <string[]>] [-filter <string>] [-force] [-passThru] [-credential <PSCredential>] [-whatIf] [-confirm] [<CommonParameters>]
DETAILED DESCRIPTION
Sets the value of a property at the specified location. Works with many different properties in many different locations.
PARAMETERS
-path <string[]>
Specifies the path to the items with the property to be set.
Required? |
true |
Position? |
1 |
Default value |
N/A - The path must be specified |
Accept pipeline input? |
true (ByPropertyName) |
Accept wildcard characters? |
true |
-inputObject <psobject>
Specifies the name of the properties to set.
Required? |
true |
Position? |
named |
Default value |
Null |
Accept pipeline input? |
true (ByValue, 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[]>
Specifies those items upon which the cmdlet is not to act and include all others.
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 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 |
-passThru <SwitchParameter>
Passes the object created by this cmdlet through the pipeline. By default, this cmdlet does not pass any objects through the pipeline.
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 |
-name <string>
Specfies the name of the property.
Required? |
true |
Position? |
2 |
Default value |
|
Accept pipeline input? |
true (ByPropertyName) |
Accept wildcard characters? |
false |
-value <Object>
Specifies the value of the property.
Required? |
true |
Position? |
3 |
Default value |
Null |
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".
INPUT TYPE
Any
RETURN TYPE
None
NOTES
For more information, type "Get-Help Set-ItemProperty -detailed". For technical information, type "Get-Help Set-ItemProperty -full".
When specifying multiple values for a parameter, use commas to separate the values. For example, "<parameter-name> <value1>, <value2>".
EXAMPLE 1
set-itemproperty -name SmpProperty -Value exp
This command sets the value of the SmpProperty to exp.
RELATED LINKS