MatchesWindowsMaskList function

Declaration

function MatchesWindowsMaskList(const FileName: string; 
                               const Mask: string; Separator: char=';'; 
                               CaseSensitive: Boolean=False; 
                               aOpcodesAllowed: TMaskOpCodes=DefaultMaskOpCodes; 
                               aWindowsQuirksAllowed: TWindowsQuirks=DefaultWindowsQuirks)
                                : Boolean

Arguments

Function result

Description

MatchesWindowsMaskList is an overloaded Boolean function used to determine whether the specified file name matches at least one of the specified masks. MatchesWindowsMaskList is similar to MatchesMaskList, but provides support for Windows-style file system masks in the Mask argument. This includes use of the following:

foo*.*

Matches all files starting with 'foo' regardless of the file extension. Same as foo* using MatchesMaskList.

foo*.

Matches foo* but must not include a file extension.

*.

Matches any file name, but must not include a file extension.

foo.

Matches foo but not foo.txt.

foo.*

Matches foo, foo.txt, or foo.bar.

*.*

Matches any file name with an extension.

Overloaded variants of the routine provide arguments and configuration settings, including:

Filename

File name compared to the file masks in Mask.

Mask

Contains one or more file mask expressions separated by one of the values in Separator.

Separator

Contains the character(s) used as a separator between mask expressions in Mask. The default separator is the SemiColon (;) character.

CaseSensitive

Indicates whether the file name to mask comparison is case sensitive.

MatchesWindowsMaskList creates a TMaskList instance which uses the values in the Mask, Separator and Options parameters. Its MatchesWindowsMask method is called to compare the value in Filename to the Windows-style masks in the list.

The return value is True when Filename matches at least one of the masks in the list.

See also

• Masks Overview