PipelineComponent.MapInputColumn(Int32, Int32, Int32) Method

Reference

Definition

Namespace:: Microsoft.SqlServer.Dts.Pipeline

Assembly:: Microsoft.SqlServer.PipelineHost.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.

Important

This API is not CLS-compliant.

Establishes a relationship between an input column and a corresponding external metadata column.

public:
 virtual Microsoft::SqlServer::Dts::Pipeline::Wrapper::IDTSExternalMetadataColumn100 ^ MapInputColumn(int iInputID, int iInputColumnID, int iExternalMetadataColumnID);

[System.CLSCompliant(false)]
public virtual Microsoft.SqlServer.Dts.Pipeline.Wrapper.IDTSExternalMetadataColumn100 MapInputColumn (int iInputID, int iInputColumnID, int iExternalMetadataColumnID);

[<System.CLSCompliant(false)>]
abstract member MapInputColumn : int * int * int -> Microsoft.SqlServer.Dts.Pipeline.Wrapper.IDTSExternalMetadataColumn100
override this.MapInputColumn : int * int * int -> Microsoft.SqlServer.Dts.Pipeline.Wrapper.IDTSExternalMetadataColumn100

Public Overridable Function MapInputColumn (iInputID As Integer, iInputColumnID As Integer, iExternalMetadataColumnID As Integer) As IDTSExternalMetadataColumn100

Parameters

iInputID: Int32

The ID of the IDTSInput100 object.

iInputColumnID: Int32

The ID of the IDTSInputColumn100 object.

iExternalMetadataColumnID: Int32

The ID of the IDTSExternalMetadataColumn100 object.

Returns

IDTSExternalMetadataColumn100

The IDTSExternalMetadataColumn100 object that the input column is mapped to.

Attributes: CLSCompliantAttribute

Remarks

This method is called to map an input column to a column in the ExternalMetadataColumnCollection of the input. When you are developing a custom data flow component, you override this method, to ensure that the input column and the output column match, and that you want to allow the mapping to occur.

For more information about working with external metadata columns, see Implementing External Metadata.

Applies to