PipelineComponent.MapOutputColumn Method

Article
12/03/2008

Establishes a relationship between an output 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 MapOutputColumn ( _
    iOutputID As Integer, _
    iOutputColumnID As Integer, _
    iExternalMetadataColumnID As Integer, _
    bMatch As Boolean _
) As IDTSExternalMetadataColumn90

[CLSCompliantAttribute(false)] 
public virtual IDTSExternalMetadataColumn90 MapOutputColumn (
    int iOutputID,
    int iOutputColumnID,
    int iExternalMetadataColumnID,
    bool bMatch
)

[CLSCompliantAttribute(false)] 
public:
virtual IDTSExternalMetadataColumn90^ MapOutputColumn (
    int iOutputID, 
    int iOutputColumnID, 
    int iExternalMetadataColumnID, 
    bool bMatch
)

/** @attribute CLSCompliantAttribute(false) */ 
public IDTSExternalMetadataColumn90 MapOutputColumn (
    int iOutputID, 
    int iOutputColumnID, 
    int iExternalMetadataColumnID, 
    boolean bMatch
)

CLSCompliantAttribute(false) 
public function MapOutputColumn (
    iOutputID : int, 
    iOutputColumnID : int, 
    iExternalMetadataColumnID : int, 
    bMatch : boolean
) : IDTSExternalMetadataColumn90

Parameters

iOutputID
The ID of the IDTSOutput90 object.

iOutputColumnID
The ID of the IDTSOutputColumn90 object.

iExternalMetadataColumnID
The ID of the IDTSExternalMetadataColumn90 object.

bMatch
Indicates whether the columns match.

Return Value

The IDTSExternalMetadataColumn90 that is mapped to the output column.

Remarks

This method is called to map an output column to a column in the ExternalMetadataColumnCollection of the output. When you are developing a custom data flow component, you override this method, to ensure that the external columns 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