IDTSComponentMetaData100.Instantiate Method

Reference

Definition

Namespace:: Microsoft.SqlServer.Dts.Pipeline.Wrapper

Assembly:: Microsoft.SqlServer.DTSPipelineWrap.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Creates an instance of a component specified by the ComponentClassID property.

public:
 Microsoft::SqlServer::Dts::Pipeline::Wrapper::CManagedComponentWrapper ^ Instantiate();

[System.Runtime.InteropServices.DispId(104)]
public Microsoft.SqlServer.Dts.Pipeline.Wrapper.CManagedComponentWrapper Instantiate ();

[<System.Runtime.InteropServices.DispId(104)>]
abstract member Instantiate : unit -> Microsoft.SqlServer.Dts.Pipeline.Wrapper.CManagedComponentWrapper

Public Function Instantiate () As CManagedComponentWrapper

Returns

CManagedComponentWrapper

The CManagedComponentWrapper class of the component.

Attributes: DispIdAttribute

Examples

The following code sample shows how the design-time instance of a component is used to set the custom property of a component. In this example, the CustomPropertyCollection of the component metadata could be used to directly set the property, but would bypass the ability of the component to monitor and respond to changes to the property.

IDTSComponentMetaData100 cmp = dataflowTask.ComponentMetaDataCollection.New();  
cmp.ComponentClassID = "DTSAdapter.OleDbSource";  
CManagedComponentWrapper dtSource = cmp.Instantiate();  
dtSource.SetComponentProperty("SqlCommand","select * from Production.Products");

Dim cmp As IDTSComponentMetaData100 = dataflowTask.ComponentMetaDataCollection.New   
cmp.ComponentClassID = "DTSAdapter.OleDbSource"   
Dim dtSource As CManagedComponentWrapper = cmp.Instantiate   
dtSource.SetComponentProperty("SqlCommand", "select * from Production.Products")

Remarks

When this method is called, the design-time instance of the component defined by the ComponentClassID property is created. The design-time instance of the component is created to edit and configure the metadata of a component. The design-time instance should be used for editing a component, instead of directly accessing the component metadata, to allow the component to monitor and validate changes to the metadata.

Applies to

Share via