powershellscripts.com

Tutorials  PowerShell Cmdlet Help for Set-ItemProperty



NAME
Set-ItemProperty

SYNOPSIS
Creates or changes the value of a property of an item.

SYNTAX
Set-ItemProperty [-LiteralPath] -InputObject [-Credential ] [-Exclude >] [-Filter ] [-Force] [-Include ] [-PassThru] [-Confirm] [-WhatIf] [-UseTransaction] [ ameters>]

Set-ItemProperty [-Path] -InputObject [-Credential ] [-Exclude ] [-Fi
lter ] [-Force] [-Include ] [-PassThru] [-Confirm] [-WhatIf] [-UseTransaction] [ >]

Set-ItemProperty [-LiteralPath] [-Name] [-Value] [-Credential ] [-Exclud
e ] [-Filter ] [-Force] [-Include ] [-PassThru] [-Confirm] [-WhatIf] [-UseTransaction]
[]

Set-ItemProperty [-Path] [-Name] [-Value] [-Credential ] [-Exclude ng[]>] [-Filter ] [-Force] [-Include ] [-PassThru] [-Confirm] [-WhatIf] [-UseTransaction] [ nParameters>]


DESCRIPTION
The Set-ItemProperty cmdlet changes the value of the property of the specified item. You can use the cmdlet to esta
blish or change the properties of items. For example, you can use Set-ItemProperty to set the value of the IsReadOn
ly property of a file object to true.

You also use Set-ItemProperty to create and change registry values and data. For example, you can add a new registr
y entry to a key and establish or change its value.


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
Specifies those items upon which the cmdlet is not to act, and includes all others.

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 set a property on items that cannot otherwise be accessed by the user. Implementation vari
es 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
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? false

-InputObject
Specifies the object that has the properties that you want to change. Enter a variable that contains the object
or a command that gets the object.

Required? true
Position? named
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
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 name of the property.

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

-PassThru []
Returns an object representing the item property. By default, this cmdlet does not generate any output.

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

-Path
Specifies the path to the items with the property to be set.

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

-Value
Specifies the value of the property.

Required? true
Position? 3
Default value
Accept pipeline input? true (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.Management.Automation.PSObject
You can pipe objects to Set-ItemProperty.


OUTPUTS
None or System.Management.Automation.PSCustomObject
When you use the PassThru parameter, Set-ItemProperty generates a PSCustomObject object that represents the ite
m that was changed and its new property value. Otherwise, this cmdlet does not generate any output.


NOTES


The Set-ItemProperty cmdlet is designed to work with the data exposed by any provider. To list the providers av
ailable in your session, type "Get-PSProvider". For more information, see about_Providers.


-------------------------- EXAMPLE 1 --------------------------

C:\PS>set-itemproperty -path c:\GroupFiles\final.doc -name IsReadOnly -value $true


Description
-----------
This command sets the value of the IsReadOnly property of the final.doc file to true.

The command uses the Set-ItemProperty cmdlet to change the value of the property of the final.doc file. It uses the
Path parameter to specify the file. It uses the Name parameter to specify the name of the property and the Value p
arameter to specify the new value.

The $true automatic variable represents a value of TRUE. For more information, see about_Automatic_Variables.

The file is a System.IO.FileInfo object and IsReadOnly is just one of its properties. To see all of the properties
and methods of a FileInfo object, pipe the file to the Get-Member cmdlet. For example, "final.doc | get-member".





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

C:\PS>set-itemproperty -path HKLM:\Software\MyCompany -name NoOfEmployees -value 823

C:\PS>get-itemproperty -path HKLM:\Software\MyCompany

PSPath : Microsoft.PowerShell.Core\Registry::HKEY_LOCAL_MACHINE\software\mycompany
PSParentPath : Microsoft.PowerShell.Core\Registry::HKEY_LOCAL_MACHINE\software
PSChildName : mycompany
PSDrive : HKLM
PSProvider : Microsoft.PowerShell.Core\Registry
NoOfLocations : 2
NoOfEmployees : 823

C:\PS>set-itemproperty -path HKLM:\Software\MyCompany -name NoOfEmployees -value 824
C:\PS>get-itemproperty -path HKLM:\Software\MyCompany


PSPath : Microsoft.PowerShell.Core\Registry::HKEY_LOCAL_MACHINE\software\mycompany
PSParentPath : Microsoft.PowerShell.Core\Registry::HKEY_LOCAL_MACHINE\software
PSChildName : mycompany
PSDrive : HKLM
PSProvider : Microsoft.PowerShell.Core\Registry
NoOfLocations : 2
NoOfEmployees : 824


Description
-----------
This example shows how to use Set-ItemProperty to create a new registry entry and to assign a value to the entry. I
t creates the NoOfEmployees entry in the MyCompany key in HKLM\Software key and sets its value to 823.

Because registry entries are considered to be properties of the registry keys (which are items), you use Set-ItemPr
operty to create registry entries, and to establish and change their values.

The first command uses the Set-ItemProperty cmdlet to create the registry entry. It uses the Path parameter to spec
ify the path to the HKLM: drive and the Software\MyCompany key. It uses the Name parameter to specify the entry nam
e and the Value parameter to specify a value.

The second command uses the Get-ItemProperty cmdlet to see the new registry entry. If you use the Get-Item or Get-C
hildItem cmdlets, the entries do not appear because they are properties of a key, not items or child items.

The third command changes the value of the NoOfEmployees entry to 824.

You can also use the New-ItemProperty cmdlet to create the registry entry and its value and then use Set-ItemProper
ty to change the value.

For more information about the HKLM: drive, type "get-help get-psdrive". For more information about using Windows P
owerShell to manage the registry, type "get-help registry".





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

C:\PS>get-childitem weekly.txt | set-itemproperty -name IsReadOnly -value $true


Description
-----------
These commands show how to use a pipeline operator (|) to send an item to Set-ItemProperty.

The first part of the command uses the Get-ChildItem cmdlet to get an object that represents the Weekly.txt file. T
he command uses a pipeline operator to send the file object to Set-ItemProperty. The Set-ItemProperty command uses
the Name and Value parameters to specify the property and its new value.

This command is equivalent to using the InputObject parameter to specify the object that Get-ChildItem gets.






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