0 out of 1 rated this helpful - Rate this topic

ScriptComponent.ComponentMetaData Property

SQL Server 2008

Returns a reference to the component definition.

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

Syntax

C++

JScript

public IDTSComponentMetaData100 ComponentMetaData { get; }

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)

Reference

ScriptComponent Class

ScriptComponent Members

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