Copy-ItemProperty

Copies a property and value from a specified location to another location.
Copy-ItemProperty [-Path*] <String[]> [-Destination*] <String> [-Name*] <String> [-Credential [<PSCredential>]][-Exclude [<String[]>]] [-Filter [<String>]] [-Force] [-Include [<String[]>]] [-PassThru] [-Confirm] [-WhatIf][-UseTransaction [<SwitchParameter>]] [<CommonParameters>]
Copy-ItemProperty [-Destination*] <String> [-Name*] <String> [-Credential [<PSCredential>]] [-Exclude [<String[]>]][-Filter [<String>]] [-Force] [-Include [<String[]>]] [-PassThru] -LiteralPath* <String[]> [-Confirm] [-WhatIf][-UseTransaction [<SwitchParameter>]] [<CommonParameters>]

The Copy-ItemProperty cmdlet copies a property and value from a specified location to another location. For instance, you can use this cmdlet to copy one or more registry entries from one registry key to another registry key.

Parameters
-Credential [<PSCredential>]

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 Domain01User01, 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.

-Destination <String>

Specifies the path to the destination location.

-Exclude [<String[]>]

Specifies, as a string array, an item or items that this cmdlet excludes. Wildcards are permitted.

-Filter [<String>]

Specifies a filter in the provider’s format or language. The value of this parameter qualifies the Path parameter. The syntax of the filter, including the use of wildcards, depends on the provider. Filters are more efficient than other parameters, because the provider applies them when this cmdlet gets the objects rather than having Windows PowerShell filter the objects after they are retrieved.

-Force [<SwitchParameter>]

Forces the command to run without asking for user confirmation.

-Include [<String[]>]

Specifies, as a string array, an item or items upon which the cmdlet will act, excluding all others.

-LiteralPath <String[]>

Specifies a path to the item property. The value of the LiteralPath parameter 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.

-Name <String>

Specifies the name of the property to be copied.

-PassThru [<SwitchParameter>]

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

-Path <String[]>

  • This value is required
  • Accepts pipeline input ByValue

Specifies, as a string array, the path to the property to be copied.

-Confirm [<SwitchParameter>]

  • Default value is false

Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.

-WhatIf [<SwitchParameter>]

  • Default value is false

Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.

-UseTransaction [<SwitchParameter>]

  • Default value is false

Includes the command in the active transaction. This parameter is valid only when a transaction is in progress.

<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,ErrorAction, ErrorVariable, WarningAction, WarningVariable,OutBuffer, PipelineVariable, and OutVariable.

Inputs

System.String

You can pipe a string that contains a path to this cmdlet.

Outputs

None or System.Management.Automation.PSCustomObject

When you use the Passthru parameter, this cmdlet generates a PsCustomObject representing the copied item property. Otherwise, this cmdlet does not generate any output.

Examples
  1. Copy a property from a registry key to another registry key:
    PS C:> Copy-ItemProperty -Path "MyApplication" -Destination "HKLM:SoftwareMyApplicationRev2" -Name "MyProperty"
    

    This command copies the property named MyProperty from the MyApplication registry key to the MyApplicationRev2 registry key.

Additional Notes
 This cmdlet 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
Get-ItemProperty
Move-ItemProperty
New-ItemProperty
Rename-ItemProperty
Set-ItemProperty
Get-PSProvider