MatchesMaskList

Determine whether the specified file name matches at least one of the specified masks.

Declaration

Source position: masks.pas line 384

function MatchesMaskList(

const FileName: string;

const Mask: string;

Separator: Char = ';';

CaseSensitive: Boolean = False;

aOpcodesAllowed: TMaskOpCodes = DefaultMaskOpCodes

):Boolean; function MatchesMaskList(

const FileName: string;

const Mask: string;

Separator: Char;

Options: TMaskOptions

):Boolean;

Arguments

`FileName`		File name compared to the file masks in Mask.
`Mask`		one or more file mask expressions separated by one of the values in Separator.
`Separator`		Character(s) used as a separator between mask expressions in Mask.
`CaseSensitive`		True if the file name to mask comparison is case sensitive.
`aOpcodesAllowed`		Set of TMaskOpCode values allowed in the comparison.

Function result

True when Filename matches at least one of the masks in the list.

Arguments

`FileName`		File name compared to the file masks in Mask.
`Mask`		one or more file mask expressions separated by one of the values in Separator.
`Separator`		Character(s) used as a separator between mask expressions in Mask.
`Options`		TMaskOption values which enable or disable features in the comparison.

Description

MatchesMaskList is an overloaded Boolean function used to determine whether the specified file name matches at least one of the specified masks. MatchesMaskList is similar to MatchesWindowsMaskList, but uses Unix-style mask expressions. This includes use of the following:

foo*: Matches all files starting with 'foo' regardless of the file extension. Same as foo*.* using MatchesWindowsMaskList.
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 including those with an optional 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.
Options: Contains TMaskOption values which enable or disable features in the comparison. The default value is an empty set ([]).
CaseSensitive: Indicates whether the file name to mask comparison is case sensitive.

Remark:

The overloaded variant which includes the CaseSensitive argument has been deprecated. Use the variant that includes the TMaskOptions argument.

MatchesMaskList creates a TMaskList instance which uses the values in the Mask, Separator and Options parameters. Its Matches method is called to compare the value in Filename to the mask values in the list.

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

Remark:

The overloaded variant which includes a TMaskOptions parameter has been marked as deprecated in version 2.3. It will be removed in version 2.5.

MatchesMaskList

Declaration

Arguments

Function result

Arguments

Description

See also