IDTSComponentMetaData100 IDTSComponentMetaData100 IDTSComponentMetaData100 Interface

Definition

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.

public interface class IDTSComponentMetaData100 : Microsoft::SqlServer::Dts::Pipeline::Wrapper::IDTSObject100
[System.Runtime.InteropServices.Guid("C5C8827B-60EC-4B5A-9D14-724A5683811F")]
[System.Runtime.InteropServices.TypeLibType(System.Runtime.InteropServices.TypeLibTypeFlags.FDual | System.Runtime.InteropServices.TypeLibTypeFlags.FDispatchable)]
public interface IDTSComponentMetaData100 : Microsoft.SqlServer.Dts.Pipeline.Wrapper.IDTSObject100
Public Interface IDTSComponentMetaData100
Implements IDTSObject100
Derived
Attributes
Implements

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.

Properties

AreInputColumnsValid AreInputColumnsValid AreInputColumnsValid

Gets a value that indicates whether the input columns in an IDTSComponentMetaData100 reference existing columns from the upstream component.

ComponentClassID ComponentClassID ComponentClassID

Gets or sets the CLSID of a component that is described by the component metadata.

ContactInfo ContactInfo ContactInfo

Gets or sets the contact information of the developer of a component.

CustomPropertyCollection CustomPropertyCollection CustomPropertyCollection

Gets the collection of custom properties exposed by a component.

Description Description Description

Gets or sets the description of the component.

ID ID ID

Gets or sets the identifier of a component.

IdentificationString IdentificationString IdentificationString

Gets a string that uniquely identifies the component.

InputCollection InputCollection InputCollection

Gets the collection of IDTSInput100 objects for a component.

IsDefaultLocale IsDefaultLocale 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.

LocaleID LocaleID LocaleID

Gets or sets the identifier of the locale used by a component.

Name Name Name

Gets or sets the name of the component.

ObjectType ObjectType ObjectType

Gets a value indicating that the component is a data flow component.

OutputCollection OutputCollection OutputCollection

Gets the collection of IDTSOutput100 objects defined by a component.

PipelineVersion PipelineVersion PipelineVersion

Gets or sets the version of the data flow task within which a component is designed to execute.

RuntimeConnectionCollection RuntimeConnectionCollection RuntimeConnectionCollection

Gets the collection of IDTSRuntimeConnection100 objects for a component.

UsesDispositions UsesDispositions UsesDispositions

Gets or sets a value that indicates whether the component uses dispositions.

ValidateExternalMetadata ValidateExternalMetadata ValidateExternalMetadata

Gets or sets a value that indicates whether the component validates its column metadata against its external data source at design time.

Version Version Version

Gets or sets the version of the component.

Methods

FireCustomEvent(String, String, Object[], String, Boolean) FireCustomEvent(String, String, Object[], String, Boolean) FireCustomEvent(String, String, Object[], String, Boolean)

Raises a custom event defined by a component.

FireError(Int32, String, String, String, Int32, Boolean) FireError(Int32, String, String, String, Int32, Boolean) FireError(Int32, String, String, String, Int32, Boolean)

Raises an OnError(IDTSRuntimeObject100, Int32, String, String, String, Int32, String, Boolean) event.

FireInformation(Int32, String, String, String, Int32, Boolean) FireInformation(Int32, String, String, String, Int32, Boolean) FireInformation(Int32, String, String, String, Int32, Boolean)

Raises an OnInformation(IDTSRuntimeObject100, Int32, String, String, String, Int32, String, Boolean) event.

FireProgress(String, Int32, Int32, Int32, String, Boolean) FireProgress(String, Int32, Int32, Int32, String, Boolean) FireProgress(String, Int32, Int32, Int32, String, Boolean)

Raises an OnProgress(TaskHost, String, Int32, Int32, Int32, String, Boolean) event.

FireWarning(Int32, String, String, String, Int32) FireWarning(Int32, String, String, String, Int32) FireWarning(Int32, String, String, String, Int32)

Raises an OnWarning(IDTSRuntimeObject100, Int32, String, String, String, Int32, String) event.

GetComponentView() GetComponentView() GetComponentView()

Gets the IDTSComponentView100 interface for a component, which supports transactional edits of the component metadata.

GetErrorDescription(Int32) GetErrorDescription(Int32) GetErrorDescription(Int32)

Gets the description of an internal Integration Services error code.

IncrementPipelinePerfCounter(UInt32, UInt32) IncrementPipelinePerfCounter(UInt32, UInt32) IncrementPipelinePerfCounter(UInt32, UInt32)

Increments a data flow performance counter.

Instantiate() Instantiate() Instantiate()

Creates an instance of a component specified by the ComponentClassID property.

PostLogMessage(String, String, String, DateTime, DateTime, Int32, Byte[]) PostLogMessage(String, String, String, DateTime, DateTime, Int32, Byte[]) PostLogMessage(String, String, String, DateTime, DateTime, Int32, Byte[])

Writes an entry in a package log.

RemoveInvalidInputColumns() RemoveInvalidInputColumns() RemoveInvalidInputColumns()

Removes invalid IDTSInputColumn100 objects from an IDTSInputColumnCollection100.

Validate() Validate() Validate()

Invokes the validation of the component metadata.

Applies to