PipelineComponent.MapOutputColumn(Int32, Int32, Int32, Boolean) Method

Definition

Namespace:

Microsoft.SqlServer.Dts.Pipeline

Assembly:

Microsoft.SqlServer.PipelineHost.dll

Important

This API is not CLS-compliant.

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

public:
 virtual Microsoft::SqlServer::Dts::Pipeline::Wrapper::IDTSExternalMetadataColumn100 ^ MapOutputColumn(int iOutputID, int iOutputColumnID, int iExternalMetadataColumnID, bool bMatch);

[System.CLSCompliant(false)]
public virtual Microsoft.SqlServer.Dts.Pipeline.Wrapper.IDTSExternalMetadataColumn100 MapOutputColumn (int iOutputID, int iOutputColumnID, int iExternalMetadataColumnID, bool bMatch);

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

Public Overridable Function MapOutputColumn (iOutputID As Integer, iOutputColumnID As Integer, iExternalMetadataColumnID As Integer, bMatch As Boolean) As IDTSExternalMetadataColumn100

Parameters

iOutputID

Int32

The ID of the IDTSOutput100 object.

iOutputColumnID

Int32

The ID of the IDTSOutputColumn100 object.

iExternalMetadataColumnID

Int32

The ID of the IDTSExternalMetadataColumn100 object.

bMatch

Boolean

Indicates whether the columns match.

Returns

IDTSExternalMetadataColumn100

The IDTSExternalMetadataColumn100 that is mapped to the output column.

Attributes

CLSCompliantAttribute

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.