PipelineComponent.ProvideComponentProperties Method

Article
12/03/2008

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

'Declaration
Public Overridable Sub ProvideComponentProperties

public virtual void ProvideComponentProperties ()

public:
virtual void ProvideComponentProperties ()

public void ProvideComponentProperties ()

public function 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 IDTSInput90 and IDTSOutput90 object to the ComponentMetaData.

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

Example

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

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

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

Public Overrides Sub ProvideComponentProperties() 
 MyBase.RemoveAllInputsOutputsAndCustomProperties 
 Dim input As IDTSInput90 = ComponentMetaData.InputCollection.New 
 input.Name = "Input" 
 Dim output As IDTSOutput90 = ComponentMetaDAta.OutputCollection.New 
 output.Name = "Output" 
 output.SynchronousInputID = input.ID 
 Dim property As IDTSCustomProperty90 = ComponentMetaData.CustomPropertyCollection.New 
 property.Name = "RuntimeVariable" 
 property.Description = "Identifies a Variable in the package." 
End Sub

Thread Safety

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

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms