IsValidEnvVarFilePath(String,String) Method

Determine whether this string is a valid file path prefixed with an environment variable or not.

Syntax

[Extension()]
public static bool IsValidEnvVarFilePath( 
   string pathString,
   out string failureReason
)

Parameters

pathString: This string from which is determined the path validity.
failureReason: If false is returned, failureReason contains the plain english description of the failure.

Return Value

true if this string represents a valid file path prefixed with an environment variable, otherwise false.

Remarks

If this method returns true, the extension method ToEnvVarFilePath can be safely invoked on this string to obtain a IEnvVarFilePath.
In addition to the the letters and digits, the following characters are accepted in the environment variable name _(){}[]$+-#',;.@!

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