CManagedComponentWrapperClass Class

Definition

Namespace:

Microsoft.SqlServer.Dts.Pipeline.Wrapper

Assembly:

Microsoft.SqlServer.DTSPipelineWrap.dll

Represents the design-time instance of a data flow component.

public ref class CManagedComponentWrapperClass : Microsoft::SqlServer::Dts::Pipeline::Wrapper::CManagedComponentWrapper, Microsoft::SqlServer::Dts::Pipeline::Wrapper::IDTSRuntimeComponent100

[System.Runtime.InteropServices.ClassInterface(System.Runtime.InteropServices.ClassInterfaceType.None)]
[System.Runtime.InteropServices.TypeLibType(System.Runtime.InteropServices.TypeLibTypeFlags.FAggregatable | System.Runtime.InteropServices.TypeLibTypeFlags.FCanCreate)]
[System.Runtime.InteropServices.Guid("7CDF593F-DE06-4ABD-B356-7976EF7AC8E0")]
public class CManagedComponentWrapperClass : Microsoft.SqlServer.Dts.Pipeline.Wrapper.CManagedComponentWrapper, Microsoft.SqlServer.Dts.Pipeline.Wrapper.IDTSRuntimeComponent100

[<System.Runtime.InteropServices.ClassInterface(System.Runtime.InteropServices.ClassInterfaceType.None)>]
[<System.Runtime.InteropServices.TypeLibType(System.Runtime.InteropServices.TypeLibTypeFlags.FAggregatable | System.Runtime.InteropServices.TypeLibTypeFlags.FCanCreate)>]
[<System.Runtime.InteropServices.Guid("7CDF593F-DE06-4ABD-B356-7976EF7AC8E0")>]
type CManagedComponentWrapperClass = class
    interface IDTSDesigntimeComponent100
    interface CManagedComponentWrapper
    interface IDTSRuntimeComponent100

Public Class CManagedComponentWrapperClass
Implements CManagedComponentWrapper, IDTSRuntimeComponent100

Inheritance

Object

CManagedComponentWrapperClass

Attributes

ClassInterfaceAttribute GuidAttribute TypeLibTypeAttribute

Implements

CManagedComponentWrapper IDTSDesigntimeComponent100 IDTSRuntimeComponent100

Examples

The following code example adds a component to a data flow task and retrieves an instance of the CManagedComponentWrapper interface by calling the Instantiate method.

Package p = new Package();  
MainPipe mp = ((TaskHost)p.Executables.Add("DTS.Pipeline")).InnerObject as MainPipe;  

IDTSComponentMetaData100 md = mp.ComponentMetaDataCollection.New();  
md.ComponentClassID = "DTSAdapter.OleDbSource";  

CManagedComponentWrapper wrp = md.Instantiate();  

Remarks

The CManagedComponentWrapperClass represents the design-time instance of a data flow component and is the object that is used when programmatically modifying a component in a data flow task. The methods of this class are defined by the IDTSDesigntimeComponent100 interface and are used to modify the properties and collections component. The CManagedComponentWrapper interface is returned when the Instantiate method of the IDTSComponentMetaData100 interface of the component is called. This interface can be cast to an instance of the CManagedComponentWrapperClass but there are no advantages to doing this Therefore, typically this class is not used.

Constructors

CManagedComponentWrapperClass()

Instantiates an instance of the CManagedComponentWrapperClass object.

Properties

BufferManager	Sets the IDTSBufferManager100 object of the component.
ComponentMetaData	Sets the IDTSComponentMetaData100 object for the component
EventInfos	Sets the IDTSEventInfos100 collection that is associated with the component.
LogEntryInfos	Gets the IDTSLogEntryInfos100 object to the component.
ReferenceTracker	Sets the IDTSObjectReferenceTracker100 object that is associated with the component.
RequiredProductLevel	Gets a value that indicates which edition of SQL Server the data flow component requires.
VariableDispenser	Sets the IDTSVariableDispenser100 object that is associated with the component.

Methods

AcquireConnections(Object)	Establishes a connection to a connection manager.
Cleanup()	Frees resources and cleans up after the component runs.
DeleteExternalMetadataColumn(Int32, Int32)	Deletes the external metadata column at the specified index from the collection of external metadata columns.
DeleteInput(Int32)	Deletes an IDTSInput100 object from the IDTSInputCollection100 collection.
DeleteOutput(Int32)	Deletes an IDTSOutput100 object from the IDTSOutputCollection100 collection of the component.
DeleteOutputColumn(Int32, Int32)	Deletes an IDTSOutputColumn100 object from the IDTSOutputColumnCollection100 collection of the component.
DescribeRedirectedErrorCode(Int32)	Returns the description of an error code defined by the component.
GetEnumerationCollection(String)	Returns the IDTSFriendlyEnumCollection100 of a component.
InsertExternalMetadataColumnAt(Int32, Int32, String, String)	Inserts a new external metadata column into the collection of external metadata columns at the specified index.
InsertInput(DTSInsertPlacement, Int32)	Adds an IDTSInput100 object to the IDTSInputCollection100 of the component.
InsertOutput(DTSInsertPlacement, Int32)	Adds a new IDTSOutput100 object to the component.
InsertOutputColumnAt(Int32, Int32, String, String)	Creates a new IDTSOutputColumn100 object and inserts it into the IDTSOutputColumnCollection100 of the component.
MapInputColumn(Int32, Int32, Int32)	Establishes a relationship between an input column and a corresponding external metadata column.
MapOutputColumn(Int32, Int32, Int32, Boolean)	Establishes a relationship between an IDTSOutputColumn100 column and a corresponding IDTSExternalMetadataColumn100 column.
OnDeletingInputColumn(Int32, Int32)	Called when an IDTSInputColunn100 object is being deleted from an IDTSInputColumnCollection100 of the component.
OnInputPathAttached(Int32)	Called when an IDTSInput100 object of the component is attached to a downstream component.
OnInputPathDetached(Int32)	Called when the IDTSInput100 object of the component is disconnected from an upstream component.
OnOutputPathAttached(Int32)	Called when an IDTSOutput100 object of the component is attached to a downstream component.
PerformUpgrade(Int32)	Upgrades the metadata of the component to the version of the component that is installed on the local computer.
PostExecute()	Does the tasks that have to be done after the component has finished processing rows of data.
PreExecute()	Does the tasks that have to be done after the PrepareForExecute() method runs, but before the component begins to process rows of data.
PrepareForExecute()	Does the tasks that have to be done both before the component begins to process rows of data and before the PreExecute() method runs.
PrimeOutput(Int32, Int32, IDTSBuffer100)	Adds rows to the output buffers in the data flow.
ProcessInput(Int32, IDTSBuffer100)	Processes the rows of data that are received in input buffers from upstream components.
ProvideComponentProperties()	Initializes or resets the IDTSComponentMetaData100 of the component.
ReinitializeMetaData()	Called to allow the component to repair problems with the IDTSComponentMetaData100 object that were identified by the component during the Validate() method.
ReleaseConnections()	Frees the connections established by the component during AcquireConnections(Object).
SetComponentProperty(String, Object)	Assigns a value to a IDTSCustomProperty100 of the component.
SetExternalMetadataColumnDataTypeProperties(Int32, Int32, DataType, Int32, Int32, Int32, Int32)	Sets the data type properties of the specified external metadata column.
SetExternalMetadataColumnProperty(Int32, Int32, String, Object)	Sets an individual property on an external metadata column.
SetInputColumnProperty(Int32, Int32, String, Object)	Assigns a value to the IDTSCustomProperty100 of an IDTSInputColumn100 object.
SetInputProperty(Int32, String, Object)	Assigns a value to the IDTSCustomProperty100 of an IDTSInput100 object in the component.
SetOutputColumnDataTypeProperties(Int32, Int32, DataType, Int32, Int32, Int32, Int32)	Sets the data type properties of an IDTSOutputColumn100 object.
SetOutputColumnProperty(Int32, Int32, String, Object)	Assigns a value to the IDTSCustomProperty100 of an IDTSOutputColumn100 object.
SetOutputProperty(Int32, String, Object)	Call this method to set the IDTSCustomProperty100 of an IDTSOutput100 object of the component.
SetUsageType(Int32, IDTSVirtualInput100, Int32, DTSUsageType)	Creates an IDTSInputColumn100 object in the IDTSInputColumnCollection100 of the component and sets the UsageType property of the column.
Validate()	Verifies that the component is configured correctly and ready to execute.