PowerShell Commands

Convert-Path

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

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

Parameters

-LiteralPath <String[]>

  • This value is required
  • Default value is None
  • Accepts pipeline input ByPropertyName

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.

-Path <String[]>

  • This value is required
  • Default value is None
  • Accepts pipeline input ByPropertyName

Specifies the Windows PowerShell path to be converted.

-UseTransaction [<SwitchParameter>]

  • Default value is False
  • Accepts pipeline input False

Includes the command in the active transaction. This parameter is valid only when a transaction is in progress.

<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,ErrorAction, ErrorVariable, WarningAction, WarningVariable,OutBuffer, PipelineVariable, and OutVariable.

Inputs
System.String
You can pipe a path, but not a literal path, to this cmdlet.
Outputs
System.String
This cmdlet returns a string that contains the converted path.
Examples
  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.

  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.

  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.

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

 *

This work is licensed under a Creative Commons Attribution 4.0 International. It is attributed to Microsoft Corporation and can be found here.

PowerShell Commands