DTSPipelineComponentType Enum

Definition

Namespace:

Microsoft.SqlServer.Dts.Runtime

Assembly:

Microsoft.SqlServer.ManagedDTS.dll

Classifies pipeline components by category.

public enum class DTSPipelineComponentType

public enum DTSPipelineComponentType

type DTSPipelineComponentType = 

Public Enum DTSPipelineComponentType

Inheritance

Enum

DTSPipelineComponentType

Fields

Name	Value	Description
Transform	0	The component is a transformation.
SourceAdapter	1	The component is a source.
DestinationAdapter	2	The component is a destination.
View	3	The component is a view.

Examples

All pipeline components are designated a component type assignment. You can use this enumeration in a custom user interface to organize the components into various groups, or to process components depending on their type. The following example takes each PipelineComponentInfo in the PipelineComponentInfos collection, displays its properties, including the component type, which is one of the values in this enumeration.

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;  
            // Iterate through the collection,   
            // printing values for the properties.  
            foreach (PipelineComponentInfo pInfo in pInfos)  
            {  
                Console.WriteLine("ComponentType:      {0}", pInfo.ComponentType);  
                Console.WriteLine("CreationName:       {0}", pInfo.CreationName);  
                Console.WriteLine("Description:        {0}", pInfo.Description);  
                Console.WriteLine("FileName:           {0}", pInfo.FileName);  
                //Console.WriteLine("FileNameVersionString:   {0}", pInfo.FileNameVersionString);  
                Console.WriteLine("IconFile:           {0}", pInfo.IconFile);  
                Console.WriteLine("IconResource:       {0}", pInfo.IconResource);  
                Console.WriteLine("ID:                 {0}", pInfo.ID);  
                Console.WriteLine("Name:               {0}", pInfo.Name);  
                Console.WriteLine("NoEditor:           {0}", pInfo.NoEditor);  
                Console.WriteLine("ShapeProgID:        {0}", pInfo.ShapeProgID);  
                Console.WriteLine("UITypeName:         {0}", pInfo.UITypeName);  
                Console.WriteLine("--------------------------------------");  
            }  
        }  
    }  
}  

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   
            ' Iterate through the collection,   
            ' printing values for the properties.  
            Dim pInfo As PipelineComponentInfo  
            For Each pInfo In pInfos  
                Console.WriteLine("ComponentType:      {0}", pInfo.ComponentType)  
                Console.WriteLine("CreationName:       {0}", pInfo.CreationName)  
                Console.WriteLine("Description:        {0}", pInfo.Description)  
                Console.WriteLine("FileName:           {0}", pInfo.FileName)  
                'Console.WriteLine("FileNameVersionString:   {0}", pInfo.FileNameVersionString)  
                Console.WriteLine("IconFile:           {0}", pInfo.IconFile)  
                Console.WriteLine("IconResource:       {0}", pInfo.IconResource)  
                Console.WriteLine("ID:                 {0}", pInfo.ID)  
                Console.WriteLine("Name:               {0}", pInfo.Name)  
                Console.WriteLine("NoEditor:           {0}", pInfo.NoEditor)  
                Console.WriteLine("ShapeProgID:        {0}", pInfo.ShapeProgID)  
                Console.WriteLine("UITypeName:         {0}", pInfo.UITypeName)  
                Console.WriteLine("--------------------------------------")  
            Next  
        End Sub  
    End Class  

Sample Output:

ComponentType: Transform

CreationName: DTSTransform.Merge.1

Description: Merge Transformation

FileName: C:\Program Files\Microsoft SQL Server\100\DTS\PipelineComponents\TxMerge.dll

IconFile: C:\Program Files\Microsoft SQL Server\100\DTS\PipelineComponents\TxMerge.dll

IconResource: -201

ID: {08AE886A-4124-499C-B332-16E3299D225A}

Name: Merge

NoEditor: False

ShapeProgID:

UITypeName: Microsoft.DataTransformationServices.DataFlowUI.MergeUI, Microsoft.DatatransformationServices.DataFlowUI, Version=10.0.000.0, Culture=neutral, PublicKeyToken=89845dcd8080cc91

--------------------------------------

ComponentType: Transform

CreationName: DTSTransform.MergeJoin.1

Description: Merge Join Transformation

FileName: C:\Program Files\Microsoft SQL Server\100\DTS\PipelineComponents\TxMergeJoin.dll

IconFile: C:\Program Files\Microsoft SQL Server\100\DTS\PipelineComponents\TxMergeJoin.dll

IconResource: -201

ID: {0D598A60-0A32-4B1B-A72C-5030B64E3A20}

Name: Merge Join

NoEditor: False

ShapeProgID:

UITypeName: Microsoft.DataTransformationServices.Design.DtsMergeJoinComponentUI, Microsoft.DatatransformationServices.DataFlowUI, Version=10.0.000.0, Culture=neutral, PublicKeyToken=89845dcd8080cc91

--------------------------------------

Remarks

The PipelineComponentInfo class contains properties that describe pipeline components that are installed on the local computer and ready to be used in a pipeline. One property about a pipeline component is its type. To evaluate its type, the ComponentType property uses this enumeration to classify the components.