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

Searches for an element that matches the conditions defined by the specified predicate, and returns the first occurrence within the entire Array.

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

'Usage

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

returnValue = Array.Find(array, match)

'Declaration

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

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 element to search for.

Return Value

Type: T
The first element that matches the conditions defined by the specified predicate, if found; otherwise, the default value for type T.
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>)>), moving forward in the Array, starting with the first element and ending with the last element. 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 uses a Predicate<(Of <(T>)>) delegate with the Find<(Of <(T>)>) generic method to search an array of Point structures. The method the delegate represents, ProductGT10, returns true if the product of the X and Y fields is greater than 100,000. The Find<(Of <(T>)>) method calls the delegate for each element of the array, returning the first point that meets the test condition.

NoteNote:

Visual Basic and C# users do not need to create the delegate explicitly, or to specify the type argument of the generic method. The compilers determine the necessary types from the method arguments you supply.

Imports System
Imports System.Drawing

Public Class Example

    Public Shared Sub Main()

        ' Create an array of five Point structures.
        Dim points() As Point = { new Point(100, 200), _
            new Point(150, 250), new Point(250, 375), _
            new Point(275, 395), new Point(295, 450) }

        ' To find the first Point structure for which X times Y 
        ' is greater than 100000, pass the array and a delegate 
        ' that represents the ProductGT10 method to the Shared
        ' Find method of the Array class.
        Dim first As Point = Array.Find(points, _
            AddressOf ProductGT10)

        ' Note that you do not need to create the delegate 
        ' explicitly, or to specify the type parameter of the 
        ' generic method, because the compiler has enough
        ' context to determine that information for you.

        ' Display the first structure found.
        Console.WriteLine("Found: X = {0}, Y = {1}", _
            first.X, first.Y)
    End Sub

    ' This method implements the test condition for the Find
    ' method.
    Private Shared Function ProductGT10(ByVal p As Point) As Boolean
        If p.X * p.Y > 100000 Then
            Return True
        Else
            Return False
        End If
    End Function
End Class

' This code example produces the following output:
'
'Found: X = 275, Y = 395


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