Strings.Filter メソッド

  • リファレンス

定義

名前空間:
Microsoft.VisualBasic
アセンブリ:
Microsoft.VisualBasic.Core.dll
アセンブリ:
Microsoft.VisualBasic.dll

指定されたフィルター条件に基づいた文字列 (String) 配列のサブセットを含むゼロ ベースの配列を返します。

オーバーロード

Filter(Object[], String, Boolean, CompareMethod)

指定されたフィルター条件に基づいた文字列 (String) 配列のサブセットを含むゼロ ベースの配列を返します。
Filter(String[], String, Boolean, CompareMethod)

指定されたフィルター条件に基づいた文字列 (String) 配列のサブセットを含むゼロ ベースの配列を返します。

Filter(Object[], String, Boolean, CompareMethod)

ソース:
Strings.vb
ソース:
Strings.vb
ソース:
Strings.vb

指定されたフィルター条件に基づいた文字列 (String) 配列のサブセットを含むゼロ ベースの配列を返します。

public static string[]? Filter (object?[] Source, string? Match, bool Include = true, Microsoft.VisualBasic.CompareMethod Compare = Microsoft.VisualBasic.CompareMethod.Binary);
public static string[] Filter (object[] Source, string Match, bool Include = true, Microsoft.VisualBasic.CompareMethod Compare = Microsoft.VisualBasic.CompareMethod.Binary);
static member Filter : obj[] * string * bool * Microsoft.VisualBasic.CompareMethod -> string[]
Public Function Filter (Source As Object(), Match As String, Optional Include As Boolean = true, Optional Compare As CompareMethod = Microsoft.VisualBasic.CompareMethod.Binary) As String()

パラメーター

Source
Object[]

必須です。 検索対象の文字列の 1 次元配列。

Match
String

必須です。 検索する文字列。

Include
Boolean

省略可能。 戻り値の部分文字列に Match を含むか含まないかを指定する Boolean 値。 Include が True の場合、Filter 関数は、部分文字列として Match を含む配列のサブセットを返します。 Include が False の場合、Filter 関数は、部分文字列として Match を含まない配列のサブセットを返します。

Compare
CompareMethod

省略可能。 使用する文字列比較の種類を示す数値。 値については、「設定」を参照してください。

戻り値

String[]

指定されたフィルター条件に基づいた文字列 (String) 配列のサブセットを含むゼロ ベースの配列です。

例外

ArgumentException

Source が Nothing であるか、1 次元の配列ではありません。

例

この例では、 関数の使用方法を Filter 示します。

Dim testStrings(2) As String
testStrings(0) = "This"
testStrings(1) = "Is"
testStrings(2) = "It"
Dim subStrings() As String
' Returns ["This", "Is"].
subStrings = Filter(testStrings, "is", True, CompareMethod.Text)
' Returns ["This"].
subStrings = Filter(testStrings, "is", True, CompareMethod.Binary)
' Returns ["Is", "It"].
subStrings = Filter(testStrings, "is", False, CompareMethod.Binary)

注釈

内に のMatch一致が見つからない場合、Filter関数は空の配列を返Sourceします。 が にNothing設定されている場合、または が 1 次元配列でない場合Source、エラーが発生します。

関数によって Filter 返される配列には、一致する項目の数を格納するのに十分な要素のみが含まれています。

引数には Compare 、次の値を指定できます。

定数 説明
CompareMethod.Binary バイナリ比較を実行します
CompareMethod.Text テキスト比較を実行します

こちらもご覧ください

適用対象

Filter(String[], String, Boolean, CompareMethod)

ソース:
Strings.vb
ソース:
Strings.vb
ソース:
Strings.vb

指定されたフィルター条件に基づいた文字列 (String) 配列のサブセットを含むゼロ ベースの配列を返します。

public static string[]? Filter (string?[] Source, string? Match, bool Include = true, Microsoft.VisualBasic.CompareMethod Compare = Microsoft.VisualBasic.CompareMethod.Binary);
public static string[] Filter (string[] Source, string Match, bool Include = true, Microsoft.VisualBasic.CompareMethod Compare = Microsoft.VisualBasic.CompareMethod.Binary);
static member Filter : string[] * string * bool * Microsoft.VisualBasic.CompareMethod -> string[]
Public Function Filter (Source As String(), Match As String, Optional Include As Boolean = true, Optional Compare As CompareMethod = Microsoft.VisualBasic.CompareMethod.Binary) As String()

パラメーター

Source
String[]

必須です。 検索対象の文字列の 1 次元配列。

Match
String

必須です。 検索する文字列。

Include
Boolean

省略可能。 戻り値の部分文字列に Match を含むか含まないかを指定する Boolean 値。 Include が True の場合、Filter 関数は、部分文字列として Match を含む配列のサブセットを返します。 Include が False の場合、Filter 関数は、部分文字列として Match を含まない配列のサブセットを返します。

Compare
CompareMethod

省略可能。 使用する文字列比較の種類を示す数値。 値については、「設定」を参照してください。

戻り値

String[]

指定されたフィルター条件に基づいた文字列 (String) 配列のサブセットを含むゼロ ベースの配列です。

例外

ArgumentException

Source が Nothing であるか、1 次元の配列ではありません。

例

この例では、 関数の使用方法を Filter 示します。

Dim testStrings(2) As String
testStrings(0) = "This"
testStrings(1) = "Is"
testStrings(2) = "It"
Dim subStrings() As String
' Returns ["This", "Is"].
subStrings = Filter(testStrings, "is", True, CompareMethod.Text)
' Returns ["This"].
subStrings = Filter(testStrings, "is", True, CompareMethod.Binary)
' Returns ["Is", "It"].
subStrings = Filter(testStrings, "is", False, CompareMethod.Binary)

注釈

内に のMatch一致が見つからない場合、Filter関数は空の配列を返Sourceします。 が にNothing設定されている場合、または が 1 次元配列でない場合Source、エラーが発生します。

関数によって Filter 返される配列には、一致する項目の数を格納するのに十分な要素のみが含まれています。

引数には Compare 、次の値を指定できます。

定数 説明
CompareMethod.Binary バイナリ比較を実行します
CompareMethod.Text テキスト比較を実行します

こちらもご覧ください

適用対象