Convert-Path - PowerShell command help and examples

Converts a path from a Windows PowerShell path to a Windows PowerShell provider path. (Convert-Path)

... Examples      
 NAME
 
    Convert-Path 

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

 SYNTAX
 
    Convert-Path [-LiteralPath] <string[]> [-UseTransaction] [<CommonParameters>] 

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

 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. 

        Required?                    true 
        Position?                    1 
        Default value 
        Accept pipeline input?       true (ByPropertyName) 
        Accept wildcard characters?  false 

    -Path <string[]> 
        Specifies the Windows PowerShell path to be converted. 

        Required?                    true 
        Position?                    1 
        Default value 
        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 about_Transactions. 

        Required?                    false 
        Position?                    named 
        Default value 
        Accept pipeline input?       false 
        Accept wildcard characters?  false 

    <CommonParameters> 
        This cmdlet supports the common parameters: Verbose, Debug, 
        ErrorAction, ErrorVariable, WarningAction, WarningVariable, 
        OutBuffer and OutVariable. For more information, type, 
        "get-help about_commonparameters". 

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

 OUTPUTS
 
    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
 

    C:\PS>convert-path ~ 

     Description
 
    ----------- 
    This command expands the current working directory. 

    
EXAMPLE 2
 

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

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

RELATED LINKS 
    Online version: http://go.microsoft.com/fwlink/?LinkID=113289 
    about_Providers 
    Test-Path 
    Split-Path 
    Resolve-Path 
    Join-Path 

C:\Windows>powershell get-help Copy-ItemProperty -full 

Microsoft Windows [Version 10.0.19045.3693]
Copyright (c) 2023 Microsoft Corporation.

ColorConsole [Version 3.7.1000] PowerShell 2.0-Export

Windows 11, 10, 8.1, 8, 7 / Server 2022, 2019, 2016