Export (0) Print
Expand All

Strings.Filter Method (String[], String, Boolean, CompareMethod)

Returns a zero-based array containing a subset of a String array based on specified filter criteria.

Namespace: Microsoft.VisualBasic
Assembly: Microsoft.VisualBasic (in microsoft.visualbasic.dll)

public static string[] Filter (
	string[] Source,
	string Match,
	[OptionalAttribute] bool Include,
	[OptionalAttribute] CompareMethod Compare
)
public static String[] Filter (
	String[] Source, 
	String Match, 
	/** @attribute OptionalAttribute() */ boolean Include, 
	/** @attribute OptionalAttribute() */ CompareMethod Compare
)
public static function Filter (
	Source : String[], 
	Match : String, 
	Include : boolean, 
	Compare : CompareMethod
) : String[]

Parameters

Source

Required. One-dimensional array of strings to be searched.

Match

Required. String to search for.

Include

Optional. Boolean value indicating whether to return substrings that include or exclude Match. If Include is True, the Filter function returns the subset of the array that contains Match as a substring. If Include is False, the Filter function returns the subset of the array that does not contain Match as a substring.

Compare

Optional. Numeric value indicating the kind of string comparison to use. See "Settings" for values.

Return Value

Returns a zero-based array containing a subset of a String array based on specified filter criteria.

For more detailed information, see the Visual Basic topic Filter Function (Visual Basic).

If no matches of Match are found within Source, the Filter function returns an empty array. An error occurs if Source is set to Nothing or is not a one-dimensional array.

The array returned by the Filter function contains only enough elements to contain the number of matched items.

The Compare argument can have the following values.

Constant

Description

CompareMethod.Binary

Performs a binary comparison

CompareMethod.Text

Performs a textual comparison

This example demonstrates the use of the Filter function.

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)

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0

Community Additions

ADD
Show:
© 2014 Microsoft