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 | |
|---|---|---|
.gif "Public property") |
AreInputColumnsValid | Gets a value that indicates whether the input columns in an IDTSComponentMetaData100 reference existing columns from the upstream component. |
|
ComponentClassID | Gets or sets the CLSID of a component that is described by the component metadata. |
|
ContactInfo | Gets or sets the contact information of the developer of a component. |
|
CustomPropertyCollection | Gets the collection of custom properties exposed by a component. |
|
Description | Gets or sets the description of the component. |
|
ID | Gets or sets the identifier of a component. |
|
IdentificationString | Gets a string that uniquely identifies the component. |
|
InputCollection | Gets the collection of IDTSInput100 objects for a component. |
|
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 | Gets or sets the identifier of the locale used by a component. |
|
Name | Gets or sets the name of the component. |
|
ObjectType | Gets a value indicating that the component is a data flow component. |
|
OutputCollection | Gets the collection of IDTSOutput100 objects defined by a component. |
|
PipelineVersion | Gets or sets the version of the data flow task within which a component is designed to execute. |
|
RuntimeConnectionCollection | Gets the collection of IDTSRuntimeConnection100 objects for a component. |
|
UsesDispositions | Gets or sets a value that indicates whether the component uses dispositions. |
|
ValidateExternalMetadata | Gets or sets a value that indicates whether the component validates its column metadata against its external data source at design time. |
|
Version | Gets or sets the version of the component. |
Top
Methods
| Name | Description | |
|---|---|---|
.gif "Public method") |
FireCustomEvent | Raises a custom event defined by a component. |
|
FireError | Raises an OnError event. |
|
FireInformation | Raises an OnInformation event. |
|
FireProgress | Raises an OnProgress event. |
|
FireWarning | Raises an OnWarning event. |
|
GetComponentView | Gets the IDTSComponentView100 interface for a component, which supports transactional edits of the component metadata. |
|
GetErrorDescription | Gets the description of an internal Integration Services error code. |
|
IncrementPipelinePerfCounter | Increments a data flow performance counter. |
|
Instantiate | Creates an instance of a component specified by the ComponentClassID property. |
|
PostLogMessage | Writes an entry in a package log. |
|
RemoveInvalidInputColumns | Removes invalid IDTSInputColumn100 objects from an IDTSInputColumnCollection100. |
|
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.