New-Item Property

Syntax

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

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

Description

The New-ItemProperty cmdlet creates a new property for a specified item and sets its value. Typically, this cmdlet is used to create new registry values, because registry values are properties of a registry key item.

This cmdlet does not add properties to an object. To add a property to an instance of an object, use the Add-Member cmdlet. To add a property to all objects of a particular type, modify the Types.ps1xml file.

Examples

Example 1: Add a registry entry

PS C:\> New-ItemProperty -Path "HKLM:\Software\MyCompany" -Name "NoOfEmployees" -Value 822

PS C:\> Get-ItemProperty "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 : 822

This command adds a new registry entry, NoOfEmployees, to the MyCompany key of the HKLM:\Software hive.

The first command uses the Path parameter to specify the path of the MyCompany registry key. It uses the Name parameter to specify a name for the entry and the Value parameter to specify its value.

The second command uses the Get-ItemProperty cmdlet to see the new registry entry.

Example 2: Add a registry entry to a key

PS C:\> Get-Item -Path "HKLM:\Software\MyCompany" | New-ItemProperty -Name NoOfLocations -Value 3

This command adds a new registry entry to a registry key. To specify the key, it uses a pipeline operator (|) to send an object that represents the key to New-ItemProperty .

The first part of the command uses the Get-Item cmdlet to get the MyCompany registry key. The pipeline operator sends the results of the command to New-ItemProperty , which adds the new registry entry, NoOfLocations, and its value, 3, to the MyCompany key.

This command works because the parameter-binding feature of Windows PowerShell associates the path of the RegistryKey object that Get-Item returns with the LiteralPath parameter of New-ItemProperty . For more information, see about_Pipelines.

Required Parameters

Optional Parameters

Inputs

None

You cannot pipe input to this cmdlet.

Outputs

System.Management.Automation.PSCustomObject

New-ItemProperty returns a custom object that contains the new property.

Notes

• New-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
• Remove-ItemProperty
• Rename-ItemProperty
• Set-ItemProperty