NDepend.API Documentation
TryGetRelativePathFrom Method (IAbsoluteFilePath)
NDepend.Path Namespace > IAbsoluteFilePath Interface : TryGetRelativePathFrom Method
The pivot directory from which the relative path is computed.
A new relative file path representing this file relative to pivotDirectory.
If this method returns false, contains a plain-english message explaining why it failed.
Compute this file as relative from pivotDirectory. If this file is "C:\Dir1\Dir2\File.txt" and pivotDirectory is "C:\Dir1\Dir3", the returned relative file path is "..\Dir2\File.txt".
Syntax

Parameters

pivotDirectory
The pivot directory from which the relative path is computed.
relativeFilePath
A new relative file path representing this file relative to pivotDirectory.
failureReason
If this method returns false, contains a plain-english message explaining why it failed.

Return Value

true if the operation works, else returns false.
Requirements

Target Platforms: Windows 11, 10, 8, 7and Linux, MacOS with net10.0, net9.0 or net8.0 installed

See Also

Reference

IAbsoluteFilePath Interface
IAbsoluteFilePath Members