CompositeGlob.IsMatch(String) Method

Reference

Definition

Namespace:: Microsoft.Build.Globbing

Assembly:: Microsoft.Build.dll

Package:: Microsoft.Build v15.9.20

Package:: Microsoft.Build v16.11.0

Package:: Microsoft.Build v17.9.5

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Matches the given stringToMatch against the glob.

public:
 virtual bool IsMatch(System::String ^ stringToMatch);

public bool IsMatch (string stringToMatch);

abstract member IsMatch : string -> bool
override this.IsMatch : string -> bool

Public Function IsMatch (stringToMatch As String) As Boolean

Parameters

stringToMatch: String

The string to match. If the string represents a relative path, it will get normalized against the glob's root. Cannot be null.

Returns

Boolean

false if stringToMatch contains invalid path or file characters; true otherwise.

Implements

IsMatch(String)

Remarks

Matching is path aware:

Slashes are normalized.
Arguments representing relative paths are normalized against the glob's root.

For example, the glob **/*.cs does not match ../a.cs, since ../a.cs points outside of the glob root.

Applies to