Share via

  • Article

PipelineComponent.MapInputColumn Method

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

This API is not CLS-compliant. 

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

Syntax

'Declaration
<CLSCompliantAttribute(False)> _
Public Overridable Function MapInputColumn ( _
    iInputID As Integer, _
    iInputColumnID As Integer, _
    iExternalMetadataColumnID As Integer _
) As IDTSExternalMetadataColumn100
'Usage
Dim instance As PipelineComponent
Dim iInputID As Integer
Dim iInputColumnID As Integer
Dim iExternalMetadataColumnID As Integer
Dim returnValue As IDTSExternalMetadataColumn100

returnValue = instance.MapInputColumn(iInputID, _
    iInputColumnID, iExternalMetadataColumnID)

[CLSCompliantAttribute(false)]
public virtual IDTSExternalMetadataColumn100 MapInputColumn(
    int iInputID,
    int iInputColumnID,
    int iExternalMetadataColumnID
)

[CLSCompliantAttribute(false)]
public:
virtual IDTSExternalMetadataColumn100^ MapInputColumn(
    int iInputID, 
    int iInputColumnID, 
    int iExternalMetadataColumnID
)

[<CLSCompliantAttribute(false)>]
abstract MapInputColumn : 
        iInputID:int * 
        iInputColumnID:int * 
        iExternalMetadataColumnID:int -> IDTSExternalMetadataColumn100 
[<CLSCompliantAttribute(false)>]
override MapInputColumn : 
        iInputID:int * 
        iInputColumnID:int * 
        iExternalMetadataColumnID:int -> IDTSExternalMetadataColumn100 

public function MapInputColumn(
    iInputID : int, 
    iInputColumnID : int, 
    iExternalMetadataColumnID : int
) : IDTSExternalMetadataColumn100

Parameters

Return Value

Type: Microsoft.SqlServer.Dts.Pipeline.Wrapper.IDTSExternalMetadataColumn100
The IDTSExternalMetadataColumn100 object that the input column is mapped to.

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.