Array..::.Exists<(Of <(T>)>) Method
This page is specific to:.NET Framework Version:2.03.03.54.0
.NET Framework Class Library
Array..::.Exists<(Of <(T>)>) Method

Determines whether the specified array contains elements that match the conditions defined by the specified predicate.

Namespace:  System
Assembly:  mscorlib (in mscorlib.dll)
Syntax

'Usage

Dim array As T()
Dim match As Predicate(Of T)
Dim returnValue As Boolean

returnValue = Array.Exists(array, _
    match)

'Declaration

Public Shared Function Exists(Of T) ( _
    array As T(), _
    match As Predicate(Of T) _
) As Boolean

Type Parameters

T

The type of the elements of the array.

Parameters

array
Type: array<T>[]()[]
The one-dimensional, zero-based Array to search.
match
Type: System..::.Predicate<(Of <(T>)>)
The Predicate<(Of <(T>)>) that defines the conditions of the elements to search for.

Return Value

Type: System..::.Boolean
true if array contains one or more elements that match the conditions defined by the specified predicate; otherwise, false.
Exceptions

ExceptionCondition
ArgumentNullException

array is nullNothingnullptra null reference (Nothing in Visual Basic).

-or-

match is nullNothingnullptra null reference (Nothing in Visual Basic).

Remarks

The Predicate<(Of <(T>)>) is a delegate to a method that returns true if the object passed to it matches the conditions defined in the delegate. The elements of array are individually passed to the Predicate<(Of <(T>)>), and processing is stopped when a match is found.

This method is an O(n) operation, where n is the Length of array.

Examples

The following code example demonstrates the Exists<(Of <(T>)>) generic method and several other generic methods that use the Predicate<(Of <(T>)>) generic delegate.

An array of strings is created, containing 8 dinosaur names, two of which (at positions 1 and 5) end with "saurus". The code example also defines a search predicate method named EndsWithSaurus, which accepts a string parameter and returns a Boolean value indicating whether the input string ends in "saurus".

The Exists<(Of <(T>)>) method stops and returns true at the first element for which the predicate method returns true, which in this case is "Amargasaurus".

NoteNote:

In C# and Visual Basic, it is not necessary to create the Predicate<string> delegate (Predicate(Of String) in Visual Basic) explicitly. These languages infer the correct delegate from context and create it automatically.

The TrueForAll<(Of <(T>)>) generic method stops and returns false at the first element for which the predicate method returns false.

The Find<(Of <(T>)>) generic method traverses the array from the beginning, passing each element in turn to the EndsWithSaurus method. The search stops when the EndsWithSaurus method returns true for the element "Amargasaurus".

The FindLast<(Of <(T>)>) generic method is used to search the array backward from the end. It finds the element "Dilophosaurus" at position 5. The FindAll<(Of <(T>)>) generic method is used to return an array containing all the elements that end in "saurus". The elements are displayed.

Imports System

Public Class Example

    Public Shared Sub Main()

        Dim dinosaurs() As String = { "Compsognathus", _
            "Amargasaurus",   "Oviraptor",      "Velociraptor", _
            "Deinonychus",    "Dilophosaurus",  "Gallimimus", _
            "Triceratops" }

        Console.WriteLine()
        For Each dinosaur As String In dinosaurs
            Console.WriteLine(dinosaur)
        Next

        Console.WriteLine(vbLf & _
            "Array.Exists(dinosaurs, AddressOf EndsWithSaurus): {0}", _
            Array.Exists(dinosaurs, AddressOf EndsWithSaurus))

        Console.WriteLine(vbLf & _
            "Array.TrueForAll(dinosaurs, AddressOf EndsWithSaurus: {0}", _
            Array.TrueForAll(dinosaurs, AddressOf EndsWithSaurus))

        Console.WriteLine(vbLf & _
            "Array.Find(dinosaurs, AddressOf EndsWithSaurus): {0}", _
            Array.Find(dinosaurs, AddressOf EndsWithSaurus))

        Console.WriteLine(vbLf & _
            "Array.FindLast(dinosaurs, AddressOf EndsWithSaurus): {0}", _
            Array.FindLast(dinosaurs, AddressOf EndsWithSaurus))

        Console.WriteLine(vbLf & _
            "Array.FindAll(dinosaurs, AddressOf EndsWithSaurus):")
        Dim subArray() As String = _
            Array.FindAll(dinosaurs, AddressOf EndsWithSaurus)

        For Each dinosaur As String In subArray
            Console.WriteLine(dinosaur)
        Next

    End Sub

    ' Search predicate returns true if a string ends in "saurus".
    Private Shared Function EndsWithSaurus(ByVal s As String) _
        As Boolean

        ' AndAlso prevents evaluation of the second Boolean
        ' expression if the string is so short that an error
        ' would occur.
        If (s.Length > 5) AndAlso _
            (s.Substring(s.Length - 6).ToLower() = "saurus") Then
            Return True
        Else
            Return False
        End If
    End Function
End Class

' This code example produces the following output:
'
'Compsognathus
'Amargasaurus
'Oviraptor
'Velociraptor
'Deinonychus
'Dilophosaurus
'Gallimimus
'Triceratops
'
'Array.Exists(dinosaurs, AddressOf EndsWithSaurus): True
'
'Array.TrueForAll(dinosaurs, AddressOf EndsWithSaurus: False
'
'Array.Find(dinosaurs, AddressOf EndsWithSaurus): Amargasaurus
'
'Array.FindLast(dinosaurs, AddressOf EndsWithSaurus): Dilophosaurus
'
'Array.FindAll(dinosaurs, AddressOf EndsWithSaurus):
'Amargasaurus
'Dilophosaurus


Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0
See Also

Reference

© 2009 Microsoft Corporation. All rights reserved.   Terms of Use | Trademarks | Privacy Statement
Page view tracker
Rate the Lightweight library
x
Lightweight builds on ScriptFree (loband) by adding features you've requested: a SearchBox and default code language selection.
Do you like the SearchBox?
Do you like the tabbed code blocks?
How useful is this topic?
Tell us more.
Thanks
x
You're helping to improve MSDN Online.
Feedback
Switch View
Classic
Lightweight Beta
ScriptFree
Switch View