Share via


PipelineComponentInfo Class

Contains properties that describe a pipeline component that is currently installed on the local computer and are ready to be used in a pipeline.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Dts.Runtime.DtsObject
    Microsoft.SqlServer.Dts.Runtime.PipelineComponentInfo

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

Syntax

'Declaration
Public NotInheritable Class PipelineComponentInfo _
    Inherits DtsObject _
    Implements IDTSName
'Usage
Dim instance As PipelineComponentInfo
public sealed class PipelineComponentInfo : DtsObject, 
    IDTSName
public ref class PipelineComponentInfo sealed : public DtsObject, 
    IDTSName
[<SealedAttribute>]
type PipelineComponentInfo =  
    class
        inherit DtsObject
        interface IDTSName
    end
public final class PipelineComponentInfo extends DtsObject implements IDTSName

The PipelineComponentInfo type exposes the following members.

Properties

  Name Description
Public property ComponentType Returns a DTSPipelineComponentType enumerator that identifies a component as a source, destination, or transformation. This property is read-only.
Public property CreationName Returns the string used by the runtime to create an instance of the PipelineComponentInfo object and add the object to the PipelineComponentInfos collection. This property is read-only.
Public property Description Gets or sets the description of the data flow component object.
Public property FileName Returns the name of the file that contains the data flow component. This property is read-only.
Public property FileNameVersionString Returns the version of the component. This property is read-only.
Public property IconFile Returns the name of the file that contains the icon. This property is read-only.
Public property IconResource Returns the icon associated with the component object. This property is read-only.
Public property ID Returns the unique ID associated with the pipeline component. This property is read-only.
Public property Name Gets or sets the name of the component used in the graphical user interface.
Public property NoEditor Returns a Boolean that indicates if the Advanced Properties graphical editor is disabled. This field is read-only.
Public property ShapeProgID Returns the designer shape of the component. This field is read-only.
Public property UITypeName Returns the qualified name of the assembly that implements the user interface of the component. This field is read-only.

Top

Methods

  Name Description
Public method Equals Determines whether two object instances are equal. (Inherited from DtsObject.)
Protected method Finalize (Inherited from Object.)
Public method GetHashCode Returns the hash code for this instance. (Inherited from DtsObject.)
Public method GetType (Inherited from Object.)
Protected method MemberwiseClone (Inherited from Object.)
Public method ToString (Inherited from Object.)

Top

Remarks

A PipelineComponentInfo object describes a data flow component that is installed on the computer and available for clients to create. The runtime will find native data flow components by enumerating the pipeline components registered with the data flow component category ID.

The Integration Services (SSIS) Pipeline consists of the Integration Services Pipeline engine and the Integration Services Pipeline components. The Integration Services Pipeline engine extracts, transforms, and loads data when a package is run. The Integration Services Pipeline components are used to build the graphs.

Thread Safety

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