FilePathRelativeToAbsolutePath Method

This helper method can be used to convert a relative path to an absolute path based on the given base path.

Definition

Namespace: SandcastleBuilder.Utils
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2024.12.21.0

C#View Source Request Example

public static string RelativeToAbsolutePath(
	string basePath,
	string relativePath
)

VBView Source Request Example

Public Shared Function RelativeToAbsolutePath ( 
	basePath As String,
	relativePath As String
) As String

C++View Source Request Example

public:
static String^ RelativeToAbsolutePath(
	String^ basePath, 
	String^ relativePath
)

F#View Source Request Example

static member RelativeToAbsolutePath : 
        basePath : string * 
        relativePath : string -> string

Parameters

basePath String: The base path
relativePath String: A relative path

Return Value

String
An absolute path

Remarks

If the base path is null or empty, the current working folder is used.

Example

C#

string basePath = @"E:\DotNet\CS\TestProject\Source";
string relativePath = @"..\Doc\Help.html";

string absolutePath = FilePath.RelativeToAbsolutePath(basePath,
    relativePath);

Console.WriteLine(absolutePath);

// Results in: E:\DotNet\CS\TestProject\Doc\Help.html

VB

Dim basePath As String = "E:\DotNet\CS\TestProject\Source"
Dim relativePath As String = "..\Doc\Help.html"

Dim absolutePath As String = _
    FilePath.RelativeToAbsolutePath(basePath, relativePath);

Console.WriteLine(absolutePath)

' Results in: E:\DotNet\CS\TestProject\Doc\Help.html

C++

No code example is currently available or this language may not be supported.

F#

No code example is currently available or this language may not be supported.