ForEachEnumeratorInfos.Contains Method

Artykuł
12/03/2008

Specifies whether an item can be retrieved from the ForEachEnumeratorInfos collection using indexing without throwing an exception.

Namespace: Microsoft.SqlServer.Dts.Runtime
Assembly: Microsoft.SqlServer.ManagedDTS (in microsoft.sqlserver.manageddts.dll)

Syntax

'Declaration
Public Function Contains ( _
    index As Object _
) As Boolean

public bool Contains (
    Object index
)

public:
bool Contains (
    Object^ index
)

public boolean Contains (
    Object index
)

public function Contains (
    index : Object
) : boolean

Parameters

index
The name, ID, or index of the object to return from the collection.

Return Value

A Boolean that indicates whether items can be retrieved using indexing. A value of true indicates that the syntax ForEachEnumeratorInfos[x] can be used without throwing an exception. A value of false indicates that indexing cannot be used to retrieve items from the ForEachEnumeratorInfos collection.

Example

The following code sample uses the Contains method to determine if an enumerator with the name "For Each File Enumerator" is in the collection. The method returns a Boolean.

using System;
using System.Collections;
using System.Collections.Generic;
using System.Text;
using Microsoft.SqlServer.Dts.Runtime;
using Microsoft.SqlServer.Dts.Runtime.Enumerators.Item;

namespace ForEachEnums
{
    class Program
    {
        static void Main(string[] args)
        {
            Application app = new Application();
            ForEachEnumeratorInfos feInfos = app.ForEachEnumeratorInfos;

            // Search the collection by name.
            if (feInfos.Contains("For Each File Enumerator"))
                Console.WriteLine("The collection contains {0} enumerator", feInfos[0].Name);
            else
                Console.WriteLine("The collection does not contain {0} enumerator", feInfos[0].Name);
        }
    }
}

Sample Output:

The collection contains For Each File Enumerator enumerator

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms