PipelineComponentInfos.Contains Method

Artigo
12/03/2008

Returns a Boolean that indicates if the items in the collection can be accessed 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, identity, ID, or index of the PipelineComponentInfo object to locate in the collection

Return Value

A Boolean that indicates whether the collection can be accessed by name, identity, ID, or index. A value of true indicates that the collection can be accessed by using the syntax PipelineComponentInfos [index]. A value of false indicates that indexing cannot be used to retrieve items from the PipelineComponentInfos collection; using this property throws an exception.

Example

The following code sample uses Contains method to determine if a pipeline component with the name "Merge" is in the collection. The method returns a Boolean.

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

namespace TaskInfos_Item
{
    class Program
    {
        static void Main(string[] args)
        {
            Application app = new Application();
            PipelineComponentInfos pInfos = app.PipelineComponentInfos;

            // Search the collection by name.
            if (pInfos.Contains("Merge"))
                Console.WriteLine("The collection contains {0} pipeline component", pInfos[0].Name);
            else
                Console.WriteLine("The collection does not contain {0} pipeline component", pInfos[0].Name);
        }
    }
}

Imports System
Imports System.Collections.Generic
Imports System.Text
Imports Microsoft.SqlServer.Dts.Runtime
 
Namespace TaskInfos_Item
    Class Program
        Shared  Sub Main(ByVal args() As String)
            Dim app As Application =  New Application() 
            Dim pInfos As PipelineComponentInfos =  app.PipelineComponentInfos 
 
            ' Search the collection by name.
            If pInfos.Contains("Merge") Then
                Console.WriteLine("The collection contains {0} pipeline component", pInfos(0).Name)
            Else 
                Console.WriteLine("The collection does not contain {0} pipeline component", pInfos(0).Name)
            End If
        End Sub
    End Class
End Namespace

Sample Output:

The collection contains Merge pipeline component

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