IDTSExternalMetadataColumnCollection100.SetIndex(Int32, Int32) Method

  • Reference

Definition

Namespace:
Microsoft.SqlServer.Dts.Pipeline.Wrapper
Assembly:
Microsoft.SqlServer.DTSPipelineWrap.dll

Changes the location in the collection of an IDTSExternalMetadataColumn100 object.

public:
 void SetIndex(int lOldIndex, int lNewIndex);
[System.Runtime.InteropServices.DispId(19)]
public void SetIndex (int lOldIndex, int lNewIndex);
[<System.Runtime.InteropServices.DispId(19)>]
abstract member SetIndex : int * int -> unit
Public Sub SetIndex (lOldIndex As Integer, lNewIndex As Integer)

Parameters

lOldIndex
Int32

The current location in the collection of the column.

lNewIndex
Int32

The new location of the column.

Attributes
DispIdAttribute

Remarks

lOldIndex and lNewIndex are zero-based parameters. The method moves the IDTSExternalMetadataColumn100 column located at lOldIndex to the location in the collection specified by lNewIndex. Any columns after lOldIndex are shifted up in the collection until reaching lNewIndex.

As an example, consider an external metadata column collection with the following IDs for the columns:

  • Col1

  • Col2

  • Col3

  • Col4

If SetIndex is called with lOldIndex equal to 0 and lNewIndex equal to 2, the modified collection has the following order:

  • Col2

  • Col3

  • Col1

  • Col4

  • If either lOldIndex or lNewIndex are outside the bounds of the collection, a Microsoft.SqlServer.Dts.HResults.DTS_E_INVALIDINDEX exception occurs.

Applies to