Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Copy-ItemProperty

Copy-ItemProperty

microsoft.powershell.commands.management.dll

Synopsis

Copies a property and value from a specified location to another location.

Syntax

Copy-ItemProperty [-Path] [-Destination] [-Name] [-Credential] [-Exclude] [-Filter] [-Force] [-Include] [-PassThru] [-Confirm] [-WhatIf] [-UseTransaction] [<CommonParameters>]

Copy-ItemProperty [-Destination] [-Name] [-Credential] [-Exclude] [-Filter] [-Force] [-Include] [-PassThru] [-LiteralPath] [-Confirm] [-WhatIf] [-UseTransaction] [<CommonParameters>]

Detailed Description

The Copy-ItemProperty cmdlet copies a property and value from a specified location to another location. For example, you can use Copy-ItemProperty 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 "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.

Aliases

None

Required?

false

Position

named

Default value

Current user

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-Destination <String>

Specifies the path to the destination location.

Aliases

None

Required?

true

Position

2

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-Exclude <String[]>

Omits the specified items. Wildcards are permitted.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

true

-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 retrieving the objects rather than having Windows PowerShell filter the objects after they are retrieved.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

true

-Force <SwitchParameter>

Allows the cmdlet to override restrictions such as renaming existing files as long as security is not compromised.

Aliases

None

Required?

false

Position

named

Default value

False

Accept pipeline input?

false

Accept wildcard characters?

false

-Include <String[]>

Specifies only those items upon which the cmdlet will act, excluding all others.

Aliases

None

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 LiteralPath 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.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

true (ByValue, ByPropertyName)

Accept wildcard characters?

false

-Name <String>

Specifies the name of the property to be copied.

Aliases

None

Required?

true

Position

3

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-PassThru <SwitchParameter>

Returns an object representing the copied item property. By default, this cmdlet does not generate any output.

Aliases

None

Required?

false

Position

named

Default value

False

Accept pipeline input?

false

Accept wildcard characters?

false

-Path <String[]>

Specifies the path to the property to be copied.

Aliases

None

Required?

true

Position

1

Default value

None

Accept pipeline input?

true (ByValue, ByPropertyName)

Accept wildcard characters?

false

-Confirm <SwitchParameter>

Prompts you for confirmation before running the cmdlet.

Aliases

None

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.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

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

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

System.String

Return Type

None or System.Management.Automation.PSCustomObject

Notes

The Copy-ItemProperty 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.

Examples

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

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

PS C:\>copy-itemproperty -path MyApplication -destination HKLM:\Software\MyApplicationRev2 -name MyProperty

Online Version
Clear-ItemProperty
Get-ItemProperty
Move-ItemProperty
New-ItemProperty
Rename-ItemProperty
Set-ItemProperty
about_Providers