PipelineComponent.InsertExternalMetadataColumnAt Method

Inserts a new external metadata column into the collection of external metadata columns at the specified index.

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 InsertExternalMetadataColumnAt ( _
    iID As Integer, _
    iExternalMetadataColumnIndex As Integer, _
    strName As String, _
    strDescription As String _
) As IDTSExternalMetadataColumn100
'Usage
Dim instance As PipelineComponent 
Dim iID As Integer 
Dim iExternalMetadataColumnIndex As Integer 
Dim strName As String 
Dim strDescription As String 
Dim returnValue As IDTSExternalMetadataColumn100 

returnValue = instance.InsertExternalMetadataColumnAt(iID, _
    iExternalMetadataColumnIndex, strName, _
    strDescription)

[CLSCompliantAttribute(false)]
public virtual IDTSExternalMetadataColumn100 InsertExternalMetadataColumnAt(
    int iID,
    int iExternalMetadataColumnIndex,
    string strName,
    string strDescription
)

[CLSCompliantAttribute(false)]
public:
virtual IDTSExternalMetadataColumn100^ InsertExternalMetadataColumnAt(
    int iID, 
    int iExternalMetadataColumnIndex, 
    String^ strName, 
    String^ strDescription
)

[<CLSCompliantAttribute(false)>]
abstract InsertExternalMetadataColumnAt : 
        iID:int * 
        iExternalMetadataColumnIndex:int * 
        strName:string * 
        strDescription:string -> IDTSExternalMetadataColumn100 
[<CLSCompliantAttribute(false)>]
override InsertExternalMetadataColumnAt : 
        iID:int * 
        iExternalMetadataColumnIndex:int * 
        strName:string * 
        strDescription:string -> IDTSExternalMetadataColumn100

public function InsertExternalMetadataColumnAt(
    iID : int, 
    iExternalMetadataColumnIndex : int, 
    strName : String, 
    strDescription : String
) : IDTSExternalMetadataColumn100

Parameters

• iID
  Type: System.Int32
  The ID of the IDTSInput100 or IDTSOutput100 that the external metadata column is associated with.

• iExternalMetadataColumnIndex
  Type: System.Int32
  The index at which the new external metadata column should be inserted into the collection.

• strName
  Type: System.String
  The Name of the new external metadata column.

• strDescription
  Type: System.String
  The Description of the new external metadata column.

Return Value

Type: Microsoft.SqlServer.Dts.Pipeline.Wrapper.IDTSExternalMetadataColumn100
The newly created IDTSExternalMetadataColumn100.

Remarks

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

See Also

Reference

PipelineComponent Class

Microsoft.SqlServer.Dts.Pipeline Namespace