ScriptComponent.ComponentMetaData Property

Article
12/15/2008

Returns a reference to the component definition.

Espace de noms: Microsoft.SqlServer.Dts.Pipeline
Assembly: Microsoft.SqlServer.TxScript (in microsoft.sqlserver.txscript.dll)

Syntaxe

'Déclaration
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

Valeur de propriété

An IDTSComponentMetaData90 object that contains the definition of the component.

Notes

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.

Exemple

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)

Sécurité des threads

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.

Plateformes

Plateformes de développement

Pour obtenir la liste des plateformes prises en charge, consultez Configuration matérielle et logicielle requise pour l'installation de SQL Server 2005.

Plateformes cibles