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
 

Convert-Path

Convert-Path

microsoft.powershell.commands.management.dll

Synopsis

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

Syntax

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

Convert-Path [-LiteralPath] [-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 <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

System.String

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

Online Version
Join-Path
Resolve-Path
Split-Path
Test-Path
about_Providers