ScriptComponent.ComponentMetaData Property

Returns a reference to the component definition.

命名空間: Microsoft.SqlServer.Dts.Pipeline
組件: Microsoft.SqlServer.TxScript (in microsoft.sqlserver.txscript.dll)

語法

'宣告
Public ReadOnly Property ComponentMetaData As IDTSComponentMetaData90
public IDTSComponentMetaData90 ComponentMetaData { get; }
public:
property IDTSComponentMetaData90^ ComponentMetaData {
    IDTSComponentMetaData90^ get ();
}
/** @property */
public IDTSComponentMetaData90 get_ComponentMetaData ()
public function get ComponentMetaData () : IDTSComponentMetaData90

屬性值

An IDTSComponentMetaData90 object that contains the definition of the component.

備註

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.

範例

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 IDTSComponentMetaData90
...
myMetaData = Me.ComponentMetaData
myMetaData.FireError(0, "Script Component", _
  "ERROR", String.Empty, 0, pbFireAgain)

執行緒安全性

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.

平台

開發平台

如需受支援的平台清單,請參閱<安裝 SQL Server 2005 的硬體和軟體需求>。

目標平台

如需受支援的平台清單,請參閱<安裝 SQL Server 2005 的硬體和軟體需求>。

請參閱

參考

ScriptComponent Class
ScriptComponent Members
Microsoft.SqlServer.Dts.Pipeline Namespace