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
'Deklaracja
Public ReadOnly Property ComponentMetaData As IDTSComponentMetaData100
public IDTSComponentMetaData100 ComponentMetaData { get; }
public:
property IDTSComponentMetaData100^ ComponentMetaData {
IDTSComponentMetaData100^ get ();
}
/** @property */
public IDTSComponentMetaData100 get_ComponentMetaData ()
public function get ComponentMetaData () : IDTSComponentMetaData100
Property Value
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.
Example
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)
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.
Target Platforms
For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server.