Strings.Filter 方法

定义

命名空间:

Microsoft.VisualBasic

程序集:

Microsoft.VisualBasic.Core.dll

返回一个从零开始的数组，该数组包含基于指定筛选条件的 String 数组的子集。

重载

Filter(Object[], String, Boolean, CompareMethod)	返回一个从零开始的数组，该数组包含基于指定筛选条件的 String 数组的子集。
Filter(String[], String, Boolean, CompareMethod)	返回一个从零开始的数组，该数组包含基于指定筛选条件的 String 数组的子集。

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

Source:

Strings.vb

返回一个从零开始的数组，该数组包含基于指定筛选条件的 String 数组的子集。

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 数组的子集。

例外

ArgumentException

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)

注解

如果在 中Source找不到 的Match匹配项，则Filter函数将返回一个空数组。 如果 Source 设置为 Nothing 或 不是一维数组，则会发生错误。

函数返回的 Filter 数组仅包含足以包含匹配项数的元素。

参数 Compare 可以具有以下值。

返回的常量	说明
CompareMethod.Binary	执行二进制比较
CompareMethod.Text	执行文本比较

另请参阅

• Replace(String, String, String, Int32, Int32, CompareMethod)
• ArgumentException
• 字符串操作摘要

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

Source:

Strings.vb

返回一个从零开始的数组，该数组包含基于指定筛选条件的 String 数组的子集。

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 数组的子集。

例外

ArgumentException

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)

注解

如果在 中Source找不到 的Match匹配项，则Filter函数将返回一个空数组。 如果 Source 设置为 Nothing 或 不是一维数组，则会发生错误。

函数返回的 Filter 数组仅包含足以包含匹配项数的元素。

参数 Compare 可以具有以下值。

返回的常量	说明
CompareMethod.Binary	执行二进制比较
CompareMethod.Text	执行文本比较

另请参阅

• Replace(String, String, String, Int32, Int32, CompareMethod)
• ArgumentException
• 字符串操作摘要