PipelineComponent.MapInputColumn Method

Article
12/03/2008

Establishes a relationship between an input column and a corresponding external metadata column. This method 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 IDTSExternalMetadataColumn90

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

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

/** @attribute CLSCompliantAttribute(false) */ 
public IDTSExternalMetadataColumn90 MapInputColumn (
    int iInputID, 
    int iInputColumnID, 
    int iExternalMetadataColumnID
)

CLSCompliantAttribute(false) 
public function MapInputColumn (
    iInputID : int, 
    iInputColumnID : int, 
    iExternalMetadataColumnID : int
) : IDTSExternalMetadataColumn90

Parameters

iInputID
The ID of the IDTSInput90 object.

iInputColumnID
The ID of the IDTSInputColumn90 object.

iExternalMetadataColumnID
The ID of the IDTSExternalMetadataColumn90 object.

Return Value

The IDTSExternalMetadataColumn90 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.

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms