• Article

ScriptComponent.ComponentMetaData Property

Returns a reference to the component definition.

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

Syntax

'Declaration
Public ReadOnly Property ComponentMetaData As IDTSComponentMetaData100
    Get
'Usage
Dim instance As ScriptComponent
Dim value As IDTSComponentMetaData100

value = instance.ComponentMetaData

public IDTSComponentMetaData100 ComponentMetaData { get; }

public:
property IDTSComponentMetaData100^ ComponentMetaData {
    IDTSComponentMetaData100^ get ();
}

member ComponentMetaData : IDTSComponentMetaData100

function get ComponentMetaData () : IDTSComponentMetaData100

Property Value

Type: Microsoft.SqlServer.Dts.Pipeline.Wrapper.IDTSComponentMetaData100
An IDTSComponentMetaData100 object that contains the definition of the component.

Remarks

The Script component developer does not use the ScriptComponent class directly, but indirectly, by coding the methods and properties of the ScriptMain class, which inherits from ScriptComponent through the UserComponent class.

The developer can use the ComponentMetaData property of the ScriptMain class to raise errors, warnings, and informational messages to the data flow engine.

Examples

The following code sample shows how the Script component developer can use the ComponentMetaData property to raise an error from within the Script component.

Private myMetaData As IDTSComponentMetaData100
...
myMetaData = Me.ComponentMetaData
myMetaData.FireError(0, "Script Component", _
  "ERROR", String.Empty, 0, pbFireAgain)