Share via

Convert-Path

Module:
Microsoft.PowerShell.Management Module

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

Syntax

Path (Default) 

Convert-Path
    [-Path] <String[]>
    [-UseTransaction]
    [<CommonParameters>]

LiteralPath 

Convert-Path
    -LiteralPath <String[]>
    [-UseTransaction]
    [<CommonParameters>]

Description

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

Examples

Example 1: Convert the working directory to a standard file system path

PS C:\> Convert-Path .

This command converts the current working directory, which is represented by a dot (.), to a standard file system path.

Example 2: Convert a provider path to a standard registry path

PS C:\> Convert-Path HKLM:\Software\Microsoft

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

Example 3: Convert a path to a string

PS C:\> Convert-Path ~
C:\Users\User01

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

Parameters

-LiteralPath

Specifies, as a string array, 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.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:PSPath

Parameter sets

LiteralPath
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-Path

Specifies the Windows PowerShell path to be converted.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Path
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments: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.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:usetx

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

String

You can pipe a path, but not a literal path, to this cmdlet.

Outputs

String

This cmdlet returns a string that contains the converted path.

Notes

  • The cmdlets that contain the Path noun 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.

    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.