指定されたフィルター条件を基にして文字列配列のサブセットを含む 0 から始まる配列を返します。
構文
Filter(sourcearray, match [, include ] [, compare ] )
Filter 関数構文の引数は次のとおりです。
| 引数 | 説明 |
|---|---|
| sourcearray | 必須。 検索する文字列の 1 次元配列です。 |
| match | 必須。 検索する文字列です。 |
| include | 省略可能です。 一致を含む、または除外する部分文字列を返すかどうかを示すブール値。 include が True の場合、Filter は、一致を含む配列のサブセットを部分文字列として返します。 include が False の場合、Filter は部分文字列として一致するものが含まれていない配列のサブセットを返します。 |
| compare | 省略可能。 使用する文字列比較の種類を表す数値です。 値については、「設定」セクションをご覧ください。 |
設定
compare 引数には、次の値を指定できます。
| 定数 | 値 | 説明 |
|---|---|---|
| vbUseCompareOption | –1 | Option Compare ステートメントの設定を使用して、比較を実行します。 |
| vbBinaryCompare | 0 | バイナリの比較を実行します。 |
| vbTextCompare | 1 | テキストの比較を実行します。 |
解説
sourcearray 内で一致するものが見つからない場合、Filter は空の配列を返します。 sourcearray が Null の場合、または 1 次元配列でない場合、エラーが発生します。
Filter 関数によって返される配列には、一致したアイテムを格納するのに十分な数の要素だけが含まれます。