ConvertTo‑RelativePath

SYNOPSIS

Converts an absolute path to a relative path.

SYNTAX

ConvertTo-RelativePath [-AbsolutePath] <String> [[-CurrentLocation] <String>]
 [<CommonParameters>]

DESCRIPTION

The ConvertTo-RelativePath command takes an absolute path and converts it to a relative path based on the current location. If the absolute path starts with the current location, the function removes the current location from the beginning of the path and inserts a '.' to indicate the relative path.

EXAMPLES

EXAMPLE 1

ConvertTo-RelativePath -AbsolutePath '/source/Viscalyx.Common/source/Public/ConvertTo-RelativePath.ps1' -CurrentLocation "/source/Viscalyx.Common"

Returns "./source/Public/ConvertTo-RelativePath.ps1", which is the relative path of the given absolute path based on the current location.

PARAMETERS

-AbsolutePath

Specifies the absolute path that needs to be converted to a relative path.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-CurrentLocation

Specifies the current location used as a reference for converting the absolute path to a relative path. If not specified, the function uses the current location obtained from Get-Location.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: None
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]

OUTPUTS

[System.String]

NOTES

RELATED LINKS