• Article

PipelineComponentInfos.Item Property

Returns a PipelineComponentInfo object from the collection.

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

Syntax

'Declaration
Public ReadOnly Default Property Item ( _
    index As Object _
) As PipelineComponentInfo
    Get
'Usage
Dim instance As PipelineComponentInfos
Dim index As Object
Dim value As PipelineComponentInfo

value = instance(index)

public PipelineComponentInfo this[
    Object index
] { get; }

public:
property PipelineComponentInfo^ default[Object^ index] {
    PipelineComponentInfo^ get (Object^ index);
}

member Item : PipelineComponentInfo

JScript supports the use of indexed properties, but not the declaration of new ones.

Parameters

  • index
    Type: System.Object
    The name, ID, description, or index of the item to locate in the collection.

Remarks

If the call to the Contains method returns true, you can access the specified element in the collection by using the syntax PipelineComponentInfos[index]. However, if the Contains method returns false, this property throws an exception. In C#, this property is the indexer for the PipelineComponentInfos class

Examples

The following code example retrieves an item from the collection using two methods. The first method uses the pInfos[…] syntax to retrieve the entire object located in the first position of the collection and place it in the pInfo object. You can now retrieve all properties from the pInfo object as usual. The second method demonstrates how to retrieve a specific property, the description, from the "merge" object in the collection using the name as the indexer.

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;

            //Using the Item method syntax of [x], obtain the description
            // of the Merge entry.
            PipelineComponentInfo pInfo = pInfos["Merge"];
            String nameOfFirstItem = pInfos["Merge"].Description;
            Console.WriteLine("Description of Merge entry: {0}", nameOfFirstItem);
        }
    }
}

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 
 
            'Using the Item method syntax of [x], obtain the description
            ' of the Merge entry.
            Dim pInfo As PipelineComponentInfo =  pInfos("Merge") 
            Dim nameOfFirstItem As String =  pInfos("Merge").Description 
            Console.WriteLine("Description of Merge entry: {0}", nameOfFirstItem)
        End Sub
    End Class
End Namespace

Sample Output:

Description of Merge entry: Merge Transformation