TMask.Matches

Determines whether the specified file name matches the mask value.

Declaration

Source position: masks.pas line 57

Arguments

Function result

True when the file name matches the mask in the class instance.

Description

Matches is a Boolean function used to determine whether the specified file name matches the mask value in the class instance. Matches converts the value in AFileName to lowercase when case sensitivity is omitted from the TMaskOptions for the class instance.

Matches examines each of the UTF-8 code points in the AFileName argument, and compares the code points to the character types defined in the internal mask string. The return value is False when:

• AFileName contains invalid UTF-8 code point(s).
• The mask has an assigned expression and AFileName does not match the minimum or maximum length for the expression.
• AFileName does not match the mask expression.

The return value is True when AFileName satisfies the mask expression using the options for the class instance.

Pass values for the mask expression and its options to the constructor for the class instance.

See also