MatchesMask function

Declaration

function MatchesMask(const FileName: string; const Mask: string; 
 CaseSensitive: Boolean=False; 
 aOpcodesAllowed: TMaskOpCodes=DefaultMaskOpCodes)
: Boolean

Arguments

Function result

Description

MatchesMask is an overloaded Boolean function used to determine if the file name specified in FileName matches the specified Mask.

CaseSensitive indicates whether case sensitivity is used when comparing the file name to the mask value.

Options contains a set of zero or more TMaskOption values enabled for the comparison. The Options argument allows enabling or disabling set notation in the mask value. Specifying moDisableSets in the Options parameter will disable interpreting the ' [' character as the beginning of a set in the specified mask. Use an empty set (' []') when options from the TMaskOption enumeration are not needed.

For example:

MatchesMask('[x]','[x]',[moDisableSets]);  // returns True

MatchesMask creates a TMask instance which is used to compare the file name to the mask using the specified options. Values in Mask and Options are passed as arguments the TMask constructor. The Matches method in the instance is called using FileName as an argument, and gets the return value for the function.

See also

• Masks Overview