Convert-Path.md

external help file	Microsoft.PowerShell.Commands.Management.dll-Help.xml
Locale	en-US
Module Name	Microsoft.PowerShell.Management
ms.date	09/05/2023
online version	https://learn.microsoft.com/powershell/module/microsoft.powershell.management/convert-path?view=powershell-5.1&WT.mc_id=ps-gethelp
schema	2.0.0
aliases	cvpa
title	Convert-Path

Convert-Path

SYNOPSIS

Converts a path from a PowerShell path to a 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 PowerShell path to a PowerShell provider path.

EXAMPLES

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

This example converts the current working directory, which is represented by a dot (.), to a standard FileSystem path.

PS C:\> Convert-Path .
C:\

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

This example converts the PowerShell provider path to a standard registry path.

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

Example 3: Convert a path to a string

This example 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

PARAMETERS

-LiteralPath

Specifies, as a string array, the path to be converted. The value of the LiteralPath parameter is used exactly as it's typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences.

For more information, see about_Quoting_Rules.

Type: System.String[]
Parameter Sets: LiteralPath
Aliases: PSPath

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Path

Specifies the PowerShell path to be converted.

Type: System.String[]
Parameter Sets: Path
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: True

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

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: usetx

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

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

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.

NOTES

Windows PowerShell includes the following aliases for Convert-Path:

• cvpa

The cmdlets that contain the Path noun manipulate path names and return the names in a concise format that all PowerShell providers can interpret. They're designed for use in programs and scripts where you want to display all or part of a path 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.

Convert-Path only converts existing paths. It can't be used to convert a location that doesn't exist yet.

RELATED LINKS

Join-Path

Resolve-Path

Split-Path

Test-Path

Get-PSProvider