IDTSDesigntimeComponent100 Interface
Defines the design-time methods of a data flow component written in C++ and COM.
Namespace: Microsoft.SqlServer.Dts.Pipeline.Wrapper
Assembly: Microsoft.SqlServer.DTSPipelineWrap (in Microsoft.SqlServer.DTSPipelineWrap.dll)
Syntax
'Declaration
<GuidAttribute("FF5DD3F1-99C1-4FFB-B097-1B1B2B9E9B2D")> _
Public Interface IDTSDesigntimeComponent100
'Usage
Dim instance As IDTSDesigntimeComponent100
[GuidAttribute("FF5DD3F1-99C1-4FFB-B097-1B1B2B9E9B2D")]
public interface IDTSDesigntimeComponent100
[GuidAttribute(L"FF5DD3F1-99C1-4FFB-B097-1B1B2B9E9B2D")]
public interface class IDTSDesigntimeComponent100
[<GuidAttribute("FF5DD3F1-99C1-4FFB-B097-1B1B2B9E9B2D")>]
type IDTSDesigntimeComponent100 = interface end
public interface IDTSDesigntimeComponent100
The IDTSDesigntimeComponent100 type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
.gif "Public method") |
AcquireConnections | Establishes a connection to a connection manager. |
|
DeleteExternalMetadataColumn | Deletes the external metadata column at the specified index from the collection of external metadata columns. |
|
DeleteInput | Deletes an IDTSInput100 object from the IDTSInputCollection100 collection. |
|
DeleteOutput | Deletes an IDTSOutput100 object from the IDTSOutputCollection100 collection. |
|
DeleteOutputColumn | Deletes an IDTSOutputColumn100 object from the IDTSOutputColumnCollection100 collection. |
|
DescribeRedirectedErrorCode | Returns the description of the specified error code. |
|
GetEnumerationCollection | Returns the IDTSFriendlyEnumCollection100 of a component. |
|
InsertExternalMetadataColumnAt | Inserts a new external metadata column into the collection of external metadata columns at the specified index. |
|
InsertInput | Adds an IDTSInput100 object to the IDTSInputCollection100. |
|
InsertOutput | Adds a new IDTSOutput100 object. |
|
InsertOutputColumnAt | Creates a new IDTSOutputColumn100 object and inserts it into the IDTSOutputColumnCollection100. |
|
MapInputColumn | Establishes a relationship between an input column and a corresponding external metadata column. |
|
MapOutputColumn | Establishes a relationship between an output column and a corresponding external metadata column. |
|
OnDeletingInputColumn | Called when deleting an IDTSInputColumn100 object from the IDTSInputColumnCollection100. |
|
OnInputPathAttached | Called when an IDTSInput100 object is connected to another component through the IDTSPath100 interface. |
|
OnInputPathDetached | Called when an IDTSPath100 object that contains the specified IDTSInput100 object is deleted. |
|
OnOutputPathAttached | Called when an IDTSOutput100 object of the component is attached to a downstream component. |
|
ProvideComponentProperties | Initializes the ComponentMetaData of the component when a component is first added to the data flow task. |
|
ReinitializeMetaData | Fixes any errors identified during design-time validation that result in the component returning VS_NEEDSNEWMETADATA. |
|
ReleaseConnections | Frees the connections established during AcquireConnections at either design time or run time. |
|
SetComponentProperty | Assigns a value to an IDTSCustomProperty100 of a component. |
|
SetExternalMetadataColumnDataTypeProperties | Sets the data type properties of the specified external metadata column. |
|
SetExternalMetadataColumnProperty | Sets an individual property of an external metadata column. |
|
SetInputColumnProperty | Assigns a value to the IDTSCustomProperty100 of an IDTSInputColumn100 object. |
|
SetInputProperty | Assigns a value to the IDTSCustomProperty100 of an IDTSInput100 object. |
|
SetOutputColumnDataTypeProperties | Sets the data type properties of an IDTSOutputColumn100 object. |
|
SetOutputColumnProperty | Sets the value of an IDTSCustomProperty100 for an IDTSOutputColumn100 object. |
|
SetOutputProperty | Sets the value of an IDTSCustomProperty100 for an IDTSOutput100 object. |
|
SetUsageType | Creates an IDTSInputColumn100 object in the IDTSInputColumnCollection100 of the component and sets the UsageType property of the column. |
|
Validate | Verifies that the component is correctly configured. |
Top
Remarks
This interface is one of two interfaces implemented by data flow components; IDTSRuntimeComponent100 is the other. This interface defines the design-time interface for a component and contains methods that are called when the component properties and collections of the ComponentMetaData are modified. Managed component developers do not explicitly implement this interface, and instead use the PipelineComponent base class, which implements the methods of both these interfaces.
When programmatically adding or modifying existing components in a data flow task, the design-time instance of a component should be used instead of accessing the component metadata directly. Modifying the ComponentMetaData directly bypasses the ability of the component to validate and reject changes to its metadata, and should be avoided. Managed code developers access the design-time instance of a component, and use the methods of the IDTSDesigntimeComponent100 interface, through the CManagedComponentWrapper.
Examples
The following code example demonstrates how to access the design-time instance of a component.
Package p = new Package();
MainPipe dataFlow = ((TaskHost)p.Executables.Add("DTS.Pipeline")).InnerObject as MainPipe;
IDTSComponentMetaData100 md = dataFlow.ComponentMetaDataCollection.New();
md.ComponentClassID = "DTSAdapter.OleDbSource";
CManagedComponentWrapper wrp = md.Instantiate();
wrp.ProvideComponentProperties();
Dim p As Package = New Package
Dim dataFlow As MainPipe = CType(CType(p.Executables.Add("DTS.Pipeline"), TaskHost).InnerObject, MainPipe)
Dim md As IDTSComponentMetaData100 = dataFlow.ComponentMetaDataCollection.New
md.ComponentClassID = "DTSAdapter.OleDbSource"
Dim wrp As CManagedComponentWrapper = md.Instantiate
wrp.ProvideComponentProperties