powershellscripts.com

Tutorials  PowerShell Cmdlet Help for Move-ItemProperty



NAME
Move-ItemProperty

SYNOPSIS
Moves a property from one location to another.

SYNTAX
Move-ItemProperty [-LiteralPath] [-Destination] [-Name] [-Credential ]
[-Exclude ] [-Filter ] [-Force] [-Include ] [-PassThru] [-Confirm] [-WhatIf] [-UseTran
saction] []

Move-ItemProperty [-Path] [-Destination] [-Name] [-Credential ] [-Excl
ude ] [-Filter ] [-Force] [-Include ] [-PassThru] [-Confirm] [-WhatIf] [-UseTransaction
] []


DESCRIPTION
The Move-ItemProperty cmdlet moves a property of an item from one item to another item. For example, it can move a
registry entry from one registry key to another registry key. When you move an item property, it is added to the n
ew location and deleted from its original location.


PARAMETERS
-Credential
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
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-Destination
Specifies the path to the destination location.

Required? true
Position? 2
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-Exclude
Omits the specified items. The value of this parameter qualifies the Path parameter. Enter a path element or pa
ttern, such as "*.txt". Wildcards are permitted.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Filter
Specifies a filter in the provider's format or language. The value of this parameter qualifies the Path paramet
er. The syntax of the filter, including the use of wildcards, depends on the provider. Filters are more efficie
nt than other parameters, because the provider applies them when retrieving the objects rather than having Wind
ows PowerShell filter the objects after they are retrieved.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Force []
Allows the cmdlet to move properties to or from items that cannot otherwise be accessed by the user. Implementa
tion varies from provider to provider. For more information, see about_Providers.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Include
Moves only the specified items. The value of this parameter qualifies the Path parameter. Enter a path element
or pattern, such as "*.txt". Wildcards are permitted.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-LiteralPath
Specifies the path to the current location of the property. Unlike Path, the value of LiteralPath is used exact
ly 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? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-Name
Specifies the name of the property to be moved.

Required? true
Position? 3
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-PassThru []
Passes an object representing the item property. By default, this cmdlet does not generate any output.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Path
Specifies the path to the current location of the property. Wildcards are permitted.

Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false

-Confirm []
Prompts you for confirmation before executing the command.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-WhatIf []
Describes what would happen if you executed the command without actually executing the command.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-UseTransaction []
Includes the command in the active transaction. This parameter is valid only when a transaction is in progress.
For more information, see about_Transactions.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false


This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer and OutVariable. For more information, type,
"get-help about_commonparameters".

INPUTS
System.String
You can pipe a string that contains a path to Move-ItemProperty.


OUTPUTS
None or System.Management.Automation.PSCustomObject
When you use the PassThru parameter, Move-ItemProperty generates a PSCustomObject representing the moved item p
roperty. Otherwise, this cmdlet does not generate any output.


NOTES


The names of the Path, Destination, and Name parameters are optional. If you omit the parameter names, the unna
med parameter values must appear in this order: Path, Destination, Name. If you include the parameter names, th
e parameters can appear in any order.

You can also refer to Move-ItemProperty by its built-in alias, "mp". For more information, see about_Aliases.

The Move-ItemProperty cmdlet is designed to work with the data exposed by any provider. To list the providers a
vailable in your session, type "Get-PSProvider". For more information, see about_Providers.


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

C:\PS>move-itemproperty HKLM:\Software\MyCompany\MyApp -Name `
Version -Destination HKLM:\Software\MyCompany\NewApp


Description
-----------
This command moves the "Version" registry value, and its data, from the MyApp subkey to the NewApp subkey of the HK
LM\Software\MyCompany registry key.






RELATED LINKS
Online version: http://go.microsoft.com/fwlink/?LinkID=113351
about_Providers
Clear-ItemProperty
New-ItemProperty
Copy-ItemProperty
Rename-ItemProperty
Get-ItemProperty
Set-ItemProperty
Remove-ItemProperty