Filter-Funktion (Visual Basic)

Artikel
09/03/2008

Aktualisiert: November 2007

Gibt ein nullbasiertes Array zurück, das einen Teilbereich eines String-Arrays auf der Basis angegebener Filterkriterien enthält.

Function Filter(
   ByVal Source() As { Object | String },
   ByVal Match As String,
   Optional ByVal Include As Boolean = True,
   Optional ByVal Compare As CompareMethod = CompareMethod.Binary
)  As String()

Parameter

Source
Erforderlich. Eindimensionales Zeichenfolgenarray, das durchsucht werden soll.
Match
Erforderlich. Die Zeichenfolge, nach der gesucht werden soll.
Include
Optional. Boolean-Wert, der angibt, ob Teilzeichenfolgen zurückgegeben werden sollen, die Match beinhalten oder ausschließen. Wenn IncludeTrue ist, gibt die Filter-Funktion die Teilmenge des Arrays zurück, das Match als Teilzeichenfolge enthält. Wenn IncludeFalse ist, gibt die Filter-Funktion die Teilmenge des Arrays zurück, das Match nicht als Teilzeichenfolge enthält.
Compare
Optional. Numerischer Wert, der angibt, welche Art des Zeichenfolgenvergleichs verwendet werden soll. Werte finden Sie im Abschnitt "Einstellungen".

Einstellungen

Das Compare-Argument kann die folgenden Werte haben.

Konstante	Beschreibung
CompareMethod.Binary	Führt einen binären Vergleich durch
CompareMethod.Text	Führt einen Textvergleich durch

Ausnahmen

Ausnahmetyp	Fehlernummer	Bedingung
ArgumentException	9	Source ist Nothing oder kein eindimensionales Array.

Beachten Sie die Spalte "Fehlernummer", wenn Sie Visual Basic 6.0-Anwendungen aktualisieren, die eine unstrukturierte Fehlerbehandlung verwenden. (Sie können die Fehlernummer mit der Number-Eigenschaft (Err-Objekt) vergleichen.) Wenn möglich, sollten Sie jedoch erwägen, eine solche Fehlerkontrolle durch Übersicht über die strukturierte Ausnahmebehandlung für Visual Basic zu ersetzen.

Hinweise

Wenn keine Übereinstimmungen von Match in Source gefunden werden, gibt die Filter-Funktion ein leeres Array zurück. Es tritt ein Fehler auf, wenn Source den Wert Nothing hat oder kein eindimensionales Array ist.

Das von der Filter-Funktion zurückgegebene Array enthält lediglich genügend Elemente, um die Anzahl der übereinstimmenden Elemente aufzunehmen.

Beispiel

In diesem Beispiel wird die Verwendung der Filter-Funktion gezeigt.

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)