Export (0) Print
Expand All

Convert-Path

Updated: May 8, 2014

Applies To: Windows PowerShell 4.0

Convert-Path

Converts a path from a Windows PowerShell path to a Windows PowerShell provider path.

Aliases

The following abbreviations are aliases for this cmdlet:

  • cvpa

Syntax

Parameter Set: Path
Convert-Path [-Path] <String[]> [-UseTransaction] [ <CommonParameters>]

Parameter Set: LiteralPath
Convert-Path -LiteralPath <String[]> [-UseTransaction] [ <CommonParameters>]




Detailed Description

The Convert-Path cmdlet converts a path from a Windows PowerShell path to a Windows PowerShell provider path.

Parameters

-LiteralPath<String[]>

Specifies the path to be converted. 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.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue, ByPropertyName)

Accept Wildcard Characters?

false

-Path<String[]>

Specifies the Windows PowerShell path to be converted.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByValue, ByPropertyName)

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

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see  about_CommonParameters (http://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • System.String

    You can pipe a path (but not a literal path) to Convert-Path.


Outputs

The output type is the type of the objects that the cmdlet emits.

  • System.String

    Convert-Path returns a string that contains the converted path.


Notes

  • The cmdlets that contain the Path noun (the Path cmdlets) manipulate path names and return the names in a concise format that all Windows PowerShell providers can interpret. They are designed for use in programs and scripts where you want to display all or part of a path name in a particular format. Use them like you would use Dirname, Normpath, Realpath, Join, or other path manipulators.

    You can use the path cmdlets with several providers, including the FileSystem, Registry, and Certificate providers.

    The Convert-Path 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 converts the current working directory, which is represented by a dot (.), to a standard file system path.


PS C:\> convert-path .

-------------------------- EXAMPLE 2 --------------------------

This command converts the Windows PowerShell provider path to a standard registry path.


PS C:\> convert-path HKLM:\software\microsoft

-------------------------- EXAMPLE 3 --------------------------

This command converts the path to the home directory of the current provider, which is the FileSystem provider, to a string.


PS C:\> convert-path ~C:\Users\User01

Related topics



Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft