Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

CManagedComponentWrapperClass Class

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

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

Namespace:  Microsoft.SqlServer.Dts.Pipeline.Wrapper
Assembly:  Microsoft.SqlServer.DTSPipelineWrap (in Microsoft.SqlServer.DTSPipelineWrap.dll)
[GuidAttribute("874F7595-FB5F-40FF-96AF-FBFF8250E3EF")]
[ClassInterfaceAttribute(ClassInterfaceType.None)]
public class CManagedComponentWrapperClass : IDTSDesigntimeComponent100, 
	CManagedComponentWrapper, IDTSRuntimeComponent100

The CManagedComponentWrapperClass type exposes the following members.

  NameDescription
Public methodCManagedComponentWrapperClassInstantiates an instance of the CManagedComponentWrapperClass object.
Top
  NameDescription
Public propertyBufferManagerSets the IDTSBufferManager100 object of the component.
Public propertyComponentMetaDataSets the IDTSComponentMetaData100 object for the component
Public propertyEventInfosSets the IDTSEventInfos100 collection that is associated with the component.
Public propertyLogEntryInfosGets the IDTSLogEntryInfos100 object to the component.
Public propertyReferenceTrackerSets the IDTSObjectReferenceTracker100 object that is associated with the component.
Public propertyRequiredProductLevelGets a value that indicates which edition of SQL Server the data flow component requires.
Public propertyVariableDispenserSets the IDTSVariableDispenser100 object that is associated with the component.
Top
  NameDescription
Public methodAcquireConnectionsEstablishes a connection to a connection manager.
Public methodCleanupFrees resources and cleans up after the component runs.
Public methodDeleteExternalMetadataColumnDeletes the external metadata column at the specified index from the collection of external metadata columns.
Public methodDeleteInputDeletes an IDTSInput100 object from the IDTSInputCollection100 collection.
Public methodDeleteOutputDeletes an IDTSOutput100 object from the IDTSOutputCollection100 collection of the component.
Public methodDeleteOutputColumnDeletes an IDTSOutputColumn100 object from the IDTSOutputColumnCollection100 collection of the component.
Public methodDescribeRedirectedErrorCodeReturns the description of an error code defined by the component.
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodGetEnumerationCollectionReturns the IDTSFriendlyEnumCollection100 of a component.
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Public methodInsertExternalMetadataColumnAtInserts a new external metadata column into the collection of external metadata columns at the specified index.
Public methodInsertInputAdds an IDTSInput100 object to the IDTSInputCollection100 of the component.
Public methodInsertOutputAdds a new IDTSOutput100 object to the component.
Public methodInsertOutputColumnAtCreates a new IDTSOutputColumn100 object and inserts it into the IDTSOutputColumnCollection100 of the component.
Public methodMapInputColumnEstablishes a relationship between an input column and a corresponding external metadata column.
Public methodMapOutputColumnEstablishes a relationship between an IDTSOutputColumn100 column and a corresponding IDTSExternalMetadataColumn100 column.
Protected methodMemberwiseClone (Inherited from Object.)
Public methodOnDeletingInputColumnCalled when an IDTSInputColunn100 object is being deleted from an IDTSInputColumnCollection100 of the component.
Public methodOnInputPathAttachedCalled when an IDTSInput100 object of the component is attached to a downstream component.
Public methodOnInputPathDetachedCalled when the IDTSInput100 object of the component is disconnected from an upstream component.
Public methodOnOutputPathAttachedCalled when an IDTSOutput100 object of the component is attached to a downstream component.
Public methodPerformUpgradeUpgrades the metadata of the component to the version of the component that is installed on the local computer.
Public methodPostExecuteDoes the tasks that have to be done after the component has finished processing rows of data.
Public methodPreExecuteDoes the tasks that have to be done after the PrepareForExecute method runs, but before the component begins to process rows of data.
Public methodPrepareForExecuteDoes the tasks that have to be done both before the component begins to process rows of data and before the PreExecute method runs.
Public methodPrimeOutputAdds rows to the output buffers in the data flow.
Public methodProcessInputProcesses the rows of data that are received in input buffers from upstream components.
Public methodProvideComponentPropertiesInitializes or resets the IDTSComponentMetaData100 of the component.
Public methodReinitializeMetaDataCalled to allow the component to repair problems with the IDTSComponentMetaData100 object that were identified by the component during the Validate method.
Public methodReleaseConnectionsFrees the connections established by the component during AcquireConnections.
Public methodSetComponentPropertyAssigns a value to a IDTSCustomProperty100 of the component.
Public methodSetExternalMetadataColumnDataTypePropertiesSets the data type properties of the specified external metadata column.
Public methodSetExternalMetadataColumnPropertySets an individual property on an external metadata column.
Public methodSetInputColumnPropertyAssigns a value to the IDTSCustomProperty100 of an IDTSInputColumn100 object.
Public methodSetInputPropertyAssigns a value to the IDTSCustomProperty100 of an IDTSInput100 object in the component.
Public methodSetOutputColumnDataTypePropertiesSets the data type properties of an IDTSOutputColumn100 object.
Public methodSetOutputColumnPropertyAssigns a value to the IDTSCustomProperty100 of an IDTSOutputColumn100 object.
Public methodSetOutputPropertyCall this method to set the IDTSCustomProperty100 of an IDTSOutput100 object of the component.
Public methodSetUsageTypeCreates an IDTSInputColumn100 object in the IDTSInputColumnCollection100 of the component and sets the UsageType property of the column.
Public methodToString (Inherited from Object.)
Public methodValidateVerifies that the component is configured correctly and ready to execute.
Top

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.

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();
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.