PipelineComponentInfo Class

Article
04/26/2013

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
	ComponentType	Returns a DTSPipelineComponentType enumerator that identifies a component as a source, destination, or transformation. This property is read-only.
	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	Gets or sets the description of the data flow component object.
	FileName	Returns the name of the file that contains the data flow component. This property is read-only.
	FileNameVersionString	Returns the version of the component. This property is read-only.
	HelpCollection	Gets the help collection from which to retrieve the help.
	HelpKeyword	Gets the help keyword for the component information.
	IconFile	Returns the name of the file that contains the icon. This property is read-only.
	IconResource	Returns the icon associated with the component object. This property is read-only.
	ID	Returns the unique ID associated with the pipeline component. This property is read-only.
	Name	Gets or sets the name of the component used in the graphical user interface.
	NoEditor	Returns a Boolean that indicates if the Advanced Properties graphical editor is disabled. This field is read-only.
	SamplesTag	Gets the samples tag for the PipelineComponentInfo.
	ShapeProgID	Returns the designer shape of the component. This field is read-only.
	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
	Equals	Determines whether two object instances are equal. (Inherited from DtsObject.)
	GetHashCode	Returns the hash code for this instance. (Inherited from DtsObject.)
	GetType	(Inherited from Object.)
	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.

Share via