CManagedComponentWrapperClass Class

Article
04/26/2013

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

Inheritance Hierarchy

System.Object
Microsoft.SqlServer.Dts.Pipeline.Wrapper.CManagedComponentWrapperClass

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

Syntax

'Declaration
<GuidAttribute("874F7595-FB5F-40FF-96AF-FBFF8250E3EF")> _
<ClassInterfaceAttribute(ClassInterfaceType.None)> _
Public Class CManagedComponentWrapperClass _
    Implements IDTSDesigntimeComponent100, CManagedComponentWrapper, IDTSRuntimeComponent100
'Usage
Dim instance As CManagedComponentWrapperClass

[GuidAttribute("874F7595-FB5F-40FF-96AF-FBFF8250E3EF")]
[ClassInterfaceAttribute(ClassInterfaceType.None)]
public class CManagedComponentWrapperClass : IDTSDesigntimeComponent100, 
    CManagedComponentWrapper, IDTSRuntimeComponent100

[GuidAttribute(L"874F7595-FB5F-40FF-96AF-FBFF8250E3EF")]
[ClassInterfaceAttribute(ClassInterfaceType::None)]
public ref class CManagedComponentWrapperClass : IDTSDesigntimeComponent100, 
    CManagedComponentWrapper, IDTSRuntimeComponent100

[<GuidAttribute("874F7595-FB5F-40FF-96AF-FBFF8250E3EF")>]
[<ClassInterfaceAttribute(ClassInterfaceType.None)>]
type CManagedComponentWrapperClass =  
    class 
        interface IDTSDesigntimeComponent100 
        interface CManagedComponentWrapper 
        interface IDTSRuntimeComponent100 
    end

public class CManagedComponentWrapperClass implements IDTSDesigntimeComponent100, CManagedComponentWrapper, IDTSRuntimeComponent100

The CManagedComponentWrapperClass type exposes the following members.

Constructors

	Name	Description
	CManagedComponentWrapperClass	Instantiates an instance of the CManagedComponentWrapperClass object.

Top

Properties

	Name	Description
	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.

Top

Methods

	Name	Description
	AcquireConnections	Establishes a connection to a connection manager.
	Cleanup	Frees resources and cleans up after the component runs.
	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 of the component.
	DeleteOutputColumn	Deletes an IDTSOutputColumn100 object from the IDTSOutputColumnCollection100 collection of the component.
	DescribeRedirectedErrorCode	Returns the description of an error code defined by the component.
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	GetEnumerationCollection	Returns the IDTSFriendlyEnumCollection100 of a component.
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	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 of the component.
	InsertOutput	Adds a new IDTSOutput100 object to the component.
	InsertOutputColumnAt	Creates a new IDTSOutputColumn100 object and inserts it into the IDTSOutputColumnCollection100 of the component.
	MapInputColumn	Establishes a relationship between an input column and a corresponding external metadata column.
	MapOutputColumn	Establishes a relationship between an IDTSOutputColumn100 column and a corresponding IDTSExternalMetadataColumn100 column.
	MemberwiseClone	(Inherited from Object.)
	OnDeletingInputColumn	Called when an IDTSInputColunn100 object is being deleted from an IDTSInputColumnCollection100 of the component.
	OnInputPathAttached	Called when an IDTSInput100 object of the component is attached to a downstream component.
	OnInputPathDetached	Called when the IDTSInput100 object of the component is disconnected from an upstream component.
	OnOutputPathAttached	Called when an IDTSOutput100 object of the component is attached to a downstream component.
	PerformUpgrade	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	Adds rows to the output buffers in the data flow.
	ProcessInput	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.
	SetComponentProperty	Assigns a value to a IDTSCustomProperty100 of the component.
	SetExternalMetadataColumnDataTypeProperties	Sets the data type properties of the specified external metadata column.
	SetExternalMetadataColumnProperty	Sets an individual property on 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 in the component.
	SetOutputColumnDataTypeProperties	Sets the data type properties of an IDTSOutputColumn100 object.
	SetOutputColumnProperty	Assigns a value to the IDTSCustomProperty100 of an IDTSOutputColumn100 object.
	SetOutputProperty	Call this method to set the IDTSCustomProperty100 of an IDTSOutput100 object of the component.
	SetUsageType	Creates an IDTSInputColumn100 object in the IDTSInputColumnCollection100 of the component and sets the UsageType property of the column.
	ToString	(Inherited from Object.)
	Validate	Verifies that the component is configured correctly and ready to execute.

Top

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.

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();

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Share via