This topic has not yet been rated - Rate this topic

PipelineComponent.ProvideComponentProperties Method

SQL Server 2012

Called when a component is first added to the data flow task, to initialize the ComponentMetaData of the component.

Namespace: Microsoft.SqlServer.Dts.Pipeline
Assembly: Microsoft.SqlServer.PipelineHost (in Microsoft.SqlServer.PipelineHost.dll)

Syntax

C++

JScript

public virtual void ProvideComponentProperties()

Remarks

This method is called when a component is first added to a data flow task. It is similar to a constructor and is the method that initializes a component. Components should add their inputs, outputs, and custom properties during this method.

The base class adds synchronous IDTSInput100 and IDTSOutput100 object to the ComponentMetaData.

For more information, see Design-time Methods of a Data Flow Component.

Examples

public override void ProvideComponentProperties()
{
    // Reset the component.
    base.RemoveAllInputsOutputsAndCustomProperties();
    IDTSInput100 input = ComponentMetaData.InputCollection.New();
    input.Name = "Input";

    IDTSOutput100 output = ComponentMetaDAta.OutputCollection.New();
    output.Name = "Output";
    output.SynchronousInputID = input.ID;

    IDTSCustomProperty100 property = ComponentMetaData.CustomPropertyCollection.New();
    property.Name = "RuntimeVariable";
    property.Description = "Identifies a Variable in the package.";
}

Reference

PipelineComponent Class

Microsoft.SqlServer.Dts.Pipeline Namespace

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)

Community Additions

ADD