Strings.Filter Метод

Определение

Возвращает массив (с индексацией от нуля), который содержит подмножество массива типа 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[]

Обязательный. Одномерный массив строк, в котором необходимо выполнить поиск.

Match
String

Обязательный. Строка, которую требуется найти.

Include
Boolean

Необязательный элемент. Значение типа Boolean, указывающее, какие подстроки требуется возвращать: содержащие или не содержащие строку Match. Если параметр Include равен True, функция Filter возвращает подмножество строк массива, содержащих Match в виде подстроки. Если параметр Include равен False, функция Filter возвращает подмножество строк массива, не содержащих Match в виде подстроки.

Compare
CompareMethod

Необязательный элемент. Числовое значение, указывающее вид выполняемого сравнения строк. Сведения о значениях см. в разделе "Параметры".

Возвращаемое значение

String[]

Массив с индексацией от нуля, который содержит подмножество массива типа String, выделяемое согласно указанным условиям фильтрации.

Исключения

Source является Nothing или не является одномерным массивом.

Примеры

В этом примере показано использование 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 функция возвращает пустой массив. Ошибка возникает, если Source имеет значение Nothing или не является одномерным массивом.

Массив, возвращаемый функцией 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[]

Обязательный. Одномерный массив строк, в котором необходимо выполнить поиск.

Match
String

Обязательный. Строка, которую требуется найти.

Include
Boolean

Необязательный элемент. Значение типа Boolean, указывающее, какие подстроки требуется возвращать: содержащие или не содержащие строку Match. Если параметр Include равен True, функция Filter возвращает подмножество строк массива, содержащих Match в виде подстроки. Если параметр Include равен False, функция Filter возвращает подмножество строк массива, не содержащих Match в виде подстроки.

Compare
CompareMethod

Необязательный элемент. Числовое значение, указывающее вид выполняемого сравнения строк. Сведения о значениях см. в разделе "Параметры".

Возвращаемое значение

String[]

Массив с индексацией от нуля, который содержит подмножество массива типа String, выделяемое согласно указанным условиям фильтрации.

Исключения

Source является Nothing или не является одномерным массивом.

Примеры

В этом примере показано использование 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 функция возвращает пустой массив. Ошибка возникает, если Source имеет значение Nothing или не является одномерным массивом.

Массив, возвращаемый функцией Filter , содержит только достаточно элементов, чтобы содержать количество совпадаемых элементов.

Аргумент Compare может иметь следующие значения.

Константа Описание
CompareMethod.Binary Выполняет двоичное сравнение
CompareMethod.Text Выполняет текстовое сравнение

См. также раздел

Применяется к