Share via


PipelineComponentInfos.Contains(Object) Method

Definition

Returns a Boolean that indicates if the items in the collection can be accessed using indexing without throwing an exception.

public:
 bool Contains(System::Object ^ index);
public bool Contains (object index);
member this.Contains : obj -> bool
Public Function Contains (index As Object) As Boolean

Parameters

index
Object

The name, identity, ID, or index of the PipelineComponentInfo object to locate in the collection

Returns

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.

Examples

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

Applies to