PipelineComponent.ComponentMetaData Property

Gets the IDTSComponentMetaData100 for a component.

This API is not CLS-compliant. 

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

Syntax

'Declaration
<CLSCompliantAttribute(False)> _
Public ReadOnly Property ComponentMetaData As IDTSComponentMetaData100 
    Get
'Usage
Dim instance As PipelineComponent 
Dim value As IDTSComponentMetaData100 

value = instance.ComponentMetaData
[CLSCompliantAttribute(false)]
public IDTSComponentMetaData100 ComponentMetaData { get; }
[CLSCompliantAttribute(false)]
public:
property IDTSComponentMetaData100^ ComponentMetaData {
    IDTSComponentMetaData100^ get ();
}
[<CLSCompliantAttribute(false)>]
member ComponentMetaData : IDTSComponentMetaData100
function get ComponentMetaData () : IDTSComponentMetaData100

Property Value

Type: Microsoft.SqlServer.Dts.Pipeline.Wrapper.IDTSComponentMetaData100
The IDTSComponentMetaData100 of the data flow component.

Remarks

Components are described and persisted by their ComponentMetaData. In addition to identifying a component by the ComponentClassID property, the metadata contains the collection of IDTSInput100, IDTSOutput100, IDTSInputColumn100 and IDTSOutputColumn100 objects, in addition to any IDTSCustomProperty100 objects defined by the component.

During package design, the ComponentMetaData is modified, validated, and finally persisted in the package XML.

See Also

Reference

PipelineComponent Class

Microsoft.SqlServer.Dts.Pipeline Namespace