TryGetEnvVarFilePath(String,IEnvVarFilePath,String) Method

Try get a new IEnvVarFilePath object from this string.

Syntax

[Extension()]
public static bool TryGetEnvVarFilePath( 
   string pathString,
   out IEnvVarFilePath envVarFilePath,
   out string failureReason
)

Parameters

pathString: Represents the path.
envVarFilePath: If this method returns true, this is the returned path object.
failureReason: If this method returns false, this is the plain english description of the failure.

Return Value

true if is a valid file path prefixed with an environment variable and as a consequence, the returned is not null.

Remarks

The path represented by this string doesn't need to exist for this operation to complete properly. The environment variable prefixing the path doesn't need to exist for this operation to complete properly.

Requirements

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

Reference

PathHelpers Class
PathHelpers Members
Overload List