Set-Item Property

Syntax

Set-ItemProperty
   [-Path] <String[]>
   [-Name] <String>
   [-Value] <Object>
   [-PassThru]
   [-Force]
   [-Filter <String>]
   [-Include <String[]>]
   [-Exclude <String[]>]
   [-Credential <PSCredential>]
   [-WhatIf]
   [-Confirm]
   [-UseTransaction]
   [<CommonParameters>]

Set-ItemProperty
   [-Path] <String[]>
   -InputObject <PSObject>
   [-PassThru]
   [-Force]
   [-Filter <String>]
   [-Include <String[]>]
   [-Exclude <String[]>]
   [-Credential <PSCredential>]
   [-WhatIf]
   [-Confirm]
   [-UseTransaction]
   [<CommonParameters>]

Set-ItemProperty
   -LiteralPath <String[]>
   [-Name] <String>
   [-Value] <Object>
   [-PassThru]
   [-Force]
   [-Filter <String>]
   [-Include <String[]>]
   [-Exclude <String[]>]
   [-Credential <PSCredential>]
   [-WhatIf]
   [-Confirm]
   [-UseTransaction]
   [<CommonParameters>]

Set-ItemProperty
   -LiteralPath <String[]>
   -InputObject <PSObject>
   [-PassThru]
   [-Force]
   [-Filter <String>]
   [-Include <String[]>]
   [-Exclude <String[]>]
   [-Credential <PSCredential>]
   [-WhatIf]
   [-Confirm]
   [-UseTransaction]
   [<CommonParameters>]

Description

The Set-ItemProperty cmdlet changes the value of the property of the specified item. You can use the cmdlet to establish or change the properties of items. For example, you can use Set-ItemProperty to set the value of the IsReadOnly 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 registry entry to a key and establish or change its value.

Examples

Example 1: Set a property of a file

PS C:\> Set-ItemProperty -Path "c:\GroupFiles\final.doc" -Name IsReadOnly -Value $True

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

The command uses Set-ItemProperty to change the value of the property of the final.doc file. It uses Path to specify the file. It uses Name to specify the name of the property and the Value parameter 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, type final.doc | Get-Member .

Example 2: Create a registry entry and value

PS C:\> Set-ItemProperty -Path "HKLM:\Software\ContosoCompany" -Name "NoOfEmployees" -Value 823

PS C:\> Get-ItemProperty -Path "HKLM:\Software\ContosoCompany"



PSPath        : Microsoft.PowerShell.Core\Registry::HKEY_LOCAL_MACHINE\software\contosocompany

PSParentPath  : Microsoft.PowerShell.Core\Registry::HKEY_LOCAL_MACHINE\software

PSChildName   : contosocompany

PSDrive       : HKLM

PSProvider    : Microsoft.PowerShell.Core\Registry

NoOfLocations : 2

NoOfEmployees : 823



PS C:\> Set-ItemProperty -Path "HKLM:\Software\ContosoCompany" -Name "NoOfEmployees" -value 824

PS C:\> Get-ItemProperty -Path "HKLM:\Software\ContosoCompany"



PSPath        : Microsoft.PowerShell.Core\Registry::HKEY_LOCAL_MACHINE\software\contosocompany

PSParentPath  : Microsoft.PowerShell.Core\Registry::HKEY_LOCAL_MACHINE\software

PSChildName   : contosocompany

PSDrive       : HKLM

PSProvider    : Microsoft.PowerShell.Core\Registry

NoOfLocations : 2

NoOfEmployees : 824

This example shows how to use Set-ItemProperty to create a new registry entry and to assign a value to the entry. It creates the NoOfEmployees entry in the ContosoCompany 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-ItemProperty to create registry entries, and to establish and change their values.

The first command creates the registry entry. It uses Path to specify the path of the HKLM: drive and the Software\MyCompany key. The command uses Name to specify the entry name and Value 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-ChildItem 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-ItemProperty to change the value.

For more information about the HKLM: drive, type Get-Help Get-PSDrive . For more information about how to use Windows PowerShell to manage the registry, type Get-Help Registry .

Example 3: Modify an item by using the pipeline

PS C:\> Get-ChildItem weekly.txt | Set-ItemProperty -Name IsReadOnly -Value $True

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

The first part of the command uses Get-ChildItem to get an object that represents the Weekly.txt file. The 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.

Required Parameters

Optional Parameters

Inputs

System.Management.Automation.PSObject

You can pipe objects to this cmdlet.

Outputs

None, System.Management.Automation.PSCustomObject

This cmdlet generates a PSCustomObject object that represents the item that was changed and its new property value, if you specify the PassThru parameter. Otherwise, this cmdlet does not generate any output.

Notes

• Set-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.

*

Related Links

• Clear-ItemProperty
• Copy-ItemProperty
• Get-ItemProperty
• Move-ItemProperty
• New-ItemProperty
• Remove-ItemProperty
• Rename-ItemProperty