Share via


CManagedComponentWrapperClass Class

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
Public method CManagedComponentWrapperClass Instantiates an instance of the CManagedComponentWrapperClass object.

Top

Properties

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

Top

Methods

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

See Also

Reference

Microsoft.SqlServer.Dts.Pipeline.Wrapper Namespace