Share via


IDTSComponentMetaData100 Interface

Contains the definition of a data flow component, including the custom properties, inputs, outputs, and input and output columns defined on a data flow component.

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

Syntax

'Declaration
<GuidAttribute("887BD061-82D4-4F06-A222-337D42E7F896")> _
Public Interface IDTSComponentMetaData100 _
    Inherits IDTSObject100
'Usage
Dim instance As IDTSComponentMetaData100
[GuidAttribute("887BD061-82D4-4F06-A222-337D42E7F896")]
public interface IDTSComponentMetaData100 : IDTSObject100
[GuidAttribute(L"887BD061-82D4-4F06-A222-337D42E7F896")]
public interface class IDTSComponentMetaData100 : IDTSObject100
[<GuidAttribute("887BD061-82D4-4F06-A222-337D42E7F896")>]
type IDTSComponentMetaData100 =  
    interface 
        interface IDTSObject100 
    end
public interface IDTSComponentMetaData100 extends IDTSObject100

The IDTSComponentMetaData100 type exposes the following members.

Properties

  Name Description
Public property AreInputColumnsValid Gets a value that indicates whether the input columns in an IDTSComponentMetaData100 reference existing columns from the upstream component.
Public property ComponentClassID Gets or sets the CLSID of a component that is described by the component metadata.
Public property ContactInfo Gets or sets the contact information of the developer of a component.
Public property CustomPropertyCollection Gets the collection of custom properties exposed by a component.
Public property Description Gets or sets the description of the component.
Public property ID Gets or sets the identifier of a component.
Public property IdentificationString Gets a string that uniquely identifies the component.
Public property InputCollection Gets the collection of IDTSInput100 objects for a component.
Public property IsDefaultLocale Gets a value that indicates whether the locale used by a component is the default locale for the computer where the component is executing.
Public property LocaleID Gets or sets the identifier of the locale used by a component.
Public property Name Gets or sets the name of the component.
Public property ObjectType Gets a value indicating that the component is a data flow component.
Public property OutputCollection Gets the collection of IDTSOutput100 objects defined by a component.
Public property PipelineVersion Gets or sets the version of the data flow task within which a component is designed to execute.
Public property RuntimeConnectionCollection Gets the collection of IDTSRuntimeConnection100 objects for a component.
Public property UsesDispositions Gets or sets a value that indicates whether the component uses dispositions.
Public property ValidateExternalMetadata Gets or sets a value that indicates whether the component validates its column metadata against its external data source at design time.
Public property Version Gets or sets the version of the component.

Top

Methods

  Name Description
Public method FireCustomEvent Raises a custom event defined by a component.
Public method FireError Raises an OnError event.
Public method FireInformation Raises an OnInformation event.
Public method FireProgress Raises an OnProgress event.
Public method FireWarning Raises an OnWarning event.
Public method GetComponentView Gets the IDTSComponentView100 interface for a component, which supports transactional edits of the component metadata.
Public method GetErrorDescription Gets the description of an internal Integration Services error code.
Public method IncrementPipelinePerfCounter Increments a data flow performance counter.
Public method Instantiate Creates an instance of a component specified by the ComponentClassID property.
Public method PostLogMessage Writes an entry in a package log.
Public method RemoveInvalidInputColumns Removes invalid IDTSInputColumn100 objects from an IDTSInputColumnCollection100.
Public method Validate Invokes the validation of the component metadata.

Top

Remarks

The IDTSComponentMetaData100 describes the layout of a data flow component. It contains the input and output objects, input and output columns, and the custom properties of the component. It also contains information that identifies the assembly, or DLL, that is created during design time and execution of the component. A reference to the metadata for a component is obtained by creating a new component, using the New method, or by accessing an existing component in the ComponentMetaDataCollection collection of the MainPipeClass class.

See Also

Reference

Microsoft.SqlServer.Dts.Pipeline.Wrapper Namespace