Table of Contents

Interface IEnvVarFilePath

Namespace
NDepend.Path
Assembly
NDepend.API.dll

Represents a file path on file system, prefixed with an environment variable.

public interface IEnvVarFilePath : IFilePath, IEnvVarPath, IPath
Inherited Members
Extension Methods

Methods (5)

GetBrotherDirectoryWithName(string)

Returns a new directory path prefixed with an environment variable, representing a directory with name directoryName, located in the same directory as this file.

IEnvVarDirectoryPath GetBrotherDirectoryWithName(string directoryName)

Parameters

directoryName string

The brother directory name.

Returns

IEnvVarDirectoryPath

GetBrotherFileWithName(string)

Returns a new file path prefixed with an environment variable, refering to a file with name fileName, located in the same directory as this file.

IEnvVarFilePath GetBrotherFileWithName(string fileName)

Parameters

fileName string

The brother file name

Returns

IEnvVarFilePath

TryResolve(out IAbsoluteFilePath)

Returns EnvVarPathResolvingStatus.Success if this file path is prefixed with an environment variable that can be resolved into a drive letter or a UNC absolute file path.

EnvVarPathResolvingStatus TryResolve(out IAbsoluteFilePath pathFileResolved)

Parameters

pathFileResolved IAbsoluteFilePath

It is the absolute file path resolved returned by this method.

Returns

EnvVarPathResolvingStatus

TryResolve(out IAbsoluteFilePath, out string)

Returns EnvVarPathResolvingStatus.Success if this file path is prefixed with an environment variable that can be resolved into a drive letter or a UNC absolute file path.

bool TryResolve(out IAbsoluteFilePath pathFileResolved, out string failureReason)

Parameters

pathFileResolved IAbsoluteFilePath

It is the absolute file path resolved returned by this method.

failureReason string

If false is returned, failureReason contains the plain english description of the failure.

Returns

bool

UpdateExtension(string)

Returns a new file path prefixed with an environment variable, representing this file with its file name extension updated to newExtension.

IEnvVarFilePath UpdateExtension(string newExtension)

Parameters

newExtension string

The new file extension. It must begin with a dot followed by one or many characters.

Returns

IEnvVarFilePath