PipelineComponentInfo PipelineComponentInfo PipelineComponentInfo Class

Definition

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

public ref class PipelineComponentInfo sealed : Microsoft::SqlServer::Dts::Runtime::DtsObject, Microsoft::SqlServer::Dts::Runtime::IDTSName
public sealed class PipelineComponentInfo : Microsoft.SqlServer.Dts.Runtime.DtsObject, Microsoft.SqlServer.Dts.Runtime.IDTSName
Public NotInheritable Class PipelineComponentInfo
Inherits DtsObject
Implements IDTSName
Inheritance
PipelineComponentInfoPipelineComponentInfoPipelineComponentInfo
Implements

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.

Properties

ComponentType ComponentType ComponentType

Returns a DTSPipelineComponentType enumerator that identifies a component as a source, destination, or transformation. This property is read-only.

CreationName CreationName 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.

Description Description Description

Gets or sets the description of the data flow component object.

FileName FileName FileName

Returns the name of the file that contains the data flow component. This property is read-only.

FileNameVersionString FileNameVersionString FileNameVersionString

Returns the version of the component. This property is read-only.

HelpCollection HelpCollection HelpCollection

Gets the help collection from which to retrieve the help.

HelpKeyword HelpKeyword HelpKeyword

Gets the help keyword for the component information.

IconFile IconFile IconFile

Returns the name of the file that contains the icon. This property is read-only.

IconResource IconResource IconResource

Returns the icon associated with the component object. This property is read-only.

ID ID ID

Returns the unique ID associated with the pipeline component. This property is read-only.

Name Name Name

Gets or sets the name of the component used in the graphical user interface.

NoEditor NoEditor NoEditor

Returns a Boolean that indicates if the Advanced Properties graphical editor is disabled. This field is read-only.

SamplesTag SamplesTag SamplesTag

Gets the samples tag for the PipelineComponentInfo.

ShapeProgID ShapeProgID ShapeProgID

Returns the designer shape of the component. This field is read-only.

UITypeName UITypeName UITypeName

Returns the qualified name of the assembly that implements the user interface of the component. This field is read-only.

Methods

Equals(Object) Equals(Object) Equals(Object)

Determines whether two object instances are equal.

(Inherited from DtsObject)
GetHashCode() GetHashCode() GetHashCode()

Returns the hash code for this instance.

(Inherited from DtsObject)

Applies to