TMask.Create

Constructor for the class instance.

Declaration

Source position: masks.pas line 53

Arguments

Arguments

Description

Create is the overloaded constructor for the class instance. Overloaded variants are provided with parameter values that are used to configure the class instance.

AValue contains the pattern compared to a given file name in methods for the class. While defined as a String type, AValue is limited to the single-byte code points in the UTF-8 encoding. Using a multi-byte UTF-8 code point in AValue causes an EMaskError exception to be raised.

Each UTF-8 code point in AValue is examined, and the internal TMaskString is updated to reflect how the mask character is applied. For example:

• '*' includes the value mcAnyText in the characters for the mask.
• '?' includes the value mcAnyChar in the characters for the mask.
• '[' includes the value mcCharSet in the characters for the mask when sets have not been disabled. Otherwise, the value mcChar is added to the characters for the mask.
• All other values are literal characters and cause the value mcChar to be added to the characters for the mask.

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

AOptions contains zero or more TMaskOption values which enable or disable features in the methods for the class instance.

Create calls the private InitMaskString method to initialize the internal TMaskString instance used in the class.

See also