Strings.Filter メソッド

定義

指定したフィルター条件に基づいて、 String 配列のサブセットを含む 0 から始まる配列を返します。

オーバーロード

名前 説明
Filter(Object[], String, Boolean, CompareMethod)

指定したフィルター条件に基づいて、 String 配列のサブセットを含む 0 から始まる配列を返します。

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

指定したフィルター条件に基づいて、 String 配列のサブセットを含む 0 から始まる配列を返します。

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

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

指定したフィルター条件に基づいて、 String 配列のサブセットを含む 0 から始まる配列を返します。

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

このフィールドは省略可能です。 Boolean Matchを含む、または除外する部分文字列を返すかどうかを示す値。 IncludeTrue場合、Filter関数は、部分文字列としてMatchを含む配列のサブセットを返します。 IncludeFalse場合、Filter関数は、部分文字列としてMatchを含まない配列のサブセットを返します。

Compare
CompareMethod

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

返品

String[]

指定したフィルター条件に基づいて、 String 配列のサブセットを含む 0 から始まる配列。

例外

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

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

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

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

こちらもご覧ください

適用対象

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

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

指定したフィルター条件に基づいて、 String 配列のサブセットを含む 0 から始まる配列を返します。

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

このフィールドは省略可能です。 Boolean Matchを含む、または除外する部分文字列を返すかどうかを示す値。 IncludeTrue場合、Filter関数は、部分文字列としてMatchを含む配列のサブセットを返します。 IncludeFalse場合、Filter関数は、部分文字列としてMatchを含まない配列のサブセットを返します。

Compare
CompareMethod

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

返品

String[]

指定したフィルター条件に基づいて、 String 配列のサブセットを含む 0 から始まる配列。

例外

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

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

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

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

こちらもご覧ください

適用対象