System.Masks.MatchesMask

提供: RAD Studio API Documentation
移動先: 案内検索

Delphi

function MatchesMask(const Filename, Mask: string): Boolean;

C++

extern DELPHI_PACKAGE bool __fastcall MatchesMask(const System::UnicodeString Filename, const System::UnicodeString Mask);

プロパティ

種類 可視性 ソース ユニット
function public
System.Masks.pas
System.Masks.hpp
System.Masks System.Masks

説明

ファイル名などのソース文字列がフィルタ文字列で指定される形式に適合しているかどうかを示します。

MatchesMask 関数を呼び出すと,Filename パラメータが Mask パラメータを使って有効な値を指定しているかどうかを確認できます。有効なマスクはリテラル文字,文字セット,およびワイルドカードで構成されます。

リテラル文字は文字列内の 1 文字と一致します。リテラル文字との比較では大文字と小文字は区別されません。

文字セットは左かっこ([)で始まり右かっこ(])で終了します。両かっこの間に文字セットの要素が入ります。要素は 1 つのリテラル文字または範囲です。要素に 2 バイト文字を含めることはできません。範囲は開始値,ダッシュ(-),および終了値で指定されます。文字セットの要素はスペースやカンマで区切らないでください。1 つの文字セットは文字列内の 1 文字と一致します。文字列内の文字が文字セット内のいずれかのリテラル文字と一致しているか,あるいは文字セット内のいずれかの範囲にあれば,その文字は文字セットと一致しています。文字列内の文字が文字セットの範囲の開始値,終了値,またはその 2 つの値の間にある文字と一致していれば,その文字は範囲内にあります。文字セットとの比較では大文字と小文字は区別されません。また,文字セットの左かっこの直後に感嘆符(!)がある場合,文字セットはその文字セットに記述された文字以外のすべての文字と一致します。

ワイルドカードはアスタリスク(*)または疑問符(?)で示されます。アスタリスクは文字数に関係なくどの文字にも対応します。疑問符は任意の 1 文字に対応します。ただし,2 バイト文字を表すには,疑問符を 2 つ並べます。

MatchesMask メソッドは,文字列とマスクが一致していれば true を返し,一致していなければ false を返します。マスクの構文が無効である場合,MatchesMask メソッドは例外を生成します。

メモ:  Filename パラメータには,ファイル名を指定しなくてもかまいません。MatchesMask を使用すると,文字列を構文的に正しいマスクとの比較でチェックできます。

関連項目