< Back
Copy-ItemProperty
Post
NAME Copy-ItemProperty
SYNOPSIS
Copies a property and value from a specified location to another location.
SYNTAX
Copy-ItemProperty [-Destination] <String> [-Name] <String> [-Confirm] [-Credential <PSCredential>] [-Exclude <String[]>] [-Filter <String>]
[-Force] [-Include <String[]>] -LiteralPath <String[]> [-PassThru] [-UseTransaction] [-WhatIf] [<CommonParameters>]
Copy-ItemProperty [-Path] <String[]> [-Destination] <String> [-Name] <String> [-Confirm] [-Credential <PSCredential>] [-Exclude <String[]>]
[-Filter <String>] [-Force] [-Include <String[]>] [-PassThru] [-UseTransaction] [-WhatIf] [<CommonParameters>]
DESCRIPTION
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
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-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 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 None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Destination <String>
Specifies the path to the destination location.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Exclude <String[]>
Specifies, as a string array, an item or items that this cmdlet excludes. Wildcards are permitted.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Force [<SwitchParameter>]
Forces the command to run without asking for user confirmation.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Include <String[]>
Specifies, as a string array, an item or items upon which the cmdlet will act, excluding all others.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-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.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Name <String>
Specifies the name of the property to be copied.
Required? true
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Path <String[]>
Specifies, as a string array, the path to the property to be copied.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-UseTransaction [<SwitchParameter>]
Includes the command in the active transaction. This parameter is valid only when a transaction is in progress. For more information, see
Includes the command in the active transaction. This parameter is valid only when a transaction is in progress. For more information, see
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
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.
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.
*
Example 1: Copy a property from a registry key to another registry key
PS C:\\>Copy-ItemProperty -Path "MyApplication" -Destination "HKLM:\\Software\\MyApplicationRev2" -Name "MyProperty"
This command copies the property named MyProperty from the MyApplication registry key to the MyApplicationRev2 registry key.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=821575
Clear-ItemProperty
Get-ItemProperty
Move-ItemProperty
New-ItemProperty
Rename-ItemProperty
Set-ItemProperty
Get-PSProvider
SYNOPSIS
Copies a property and value from a specified location to another location.
SYNTAX
Copy-ItemProperty [-Destination] <String> [-Name] <String> [-Confirm] [-Credential <PSCredential>] [-Exclude <String[]>] [-Filter <String>]
[-Force] [-Include <String[]>] -LiteralPath <String[]> [-PassThru] [-UseTransaction] [-WhatIf] [<CommonParameters>]
Copy-ItemProperty [-Path] <String[]> [-Destination] <String> [-Name] <String> [-Confirm] [-Credential <PSCredential>] [-Exclude <String[]>]
[-Filter <String>] [-Force] [-Include <String[]>] [-PassThru] [-UseTransaction] [-WhatIf] [<CommonParameters>]
DESCRIPTION
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
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-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 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 None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Destination <String>
Specifies the path to the destination location.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Exclude <String[]>
Specifies, as a string array, an item or items that this cmdlet excludes. Wildcards are permitted.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Force [<SwitchParameter>]
Forces the command to run without asking for user confirmation.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Include <String[]>
Specifies, as a string array, an item or items upon which the cmdlet will act, excluding all others.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-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.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Name <String>
Specifies the name of the property to be copied.
Required? true
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Path <String[]>
Specifies, as a string array, the path to the property to be copied.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-UseTransaction [<SwitchParameter>]
Includes the command in the active transaction. This parameter is valid only when a transaction is in progress. For more information, see
Includes the command in the active transaction. This parameter is valid only when a transaction is in progress. For more information, see
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
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.
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.
*
Example 1: Copy a property from a registry key to another registry key
PS C:\\>Copy-ItemProperty -Path "MyApplication" -Destination "HKLM:\\Software\\MyApplicationRev2" -Name "MyProperty"
This command copies the property named MyProperty from the MyApplication registry key to the MyApplicationRev2 registry key.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=821575
Clear-ItemProperty
Get-ItemProperty
Move-ItemProperty
New-ItemProperty
Rename-ItemProperty
Set-ItemProperty
Get-PSProvider