IDTSExternalMetadataColumnCollection100.SetIndex Method
Changes the location in the collection of an IDTSExternalMetadataColumn100 object.
Namespace: Microsoft.SqlServer.Dts.Pipeline.Wrapper
Assembly: Microsoft.SqlServer.DTSPipelineWrap (in Microsoft.SqlServer.DTSPipelineWrap.dll)
Syntax
'Declaration
Sub SetIndex ( _
lOldIndex As Integer, _
lNewIndex As Integer _
)
'Usage
Dim instance As IDTSExternalMetadataColumnCollection100
Dim lOldIndex As Integer
Dim lNewIndex As Integer
instance.SetIndex(lOldIndex, lNewIndex)
void SetIndex(
int lOldIndex,
int lNewIndex
)
void SetIndex(
[InAttribute] int lOldIndex,
[InAttribute] int lNewIndex
)
abstract SetIndex :
lOldIndex:int *
lNewIndex:int -> unit
function SetIndex(
lOldIndex : int,
lNewIndex : int
)
Parameters
- lOldIndex
Type: System.Int32
The current location in the collection of the column.
- lNewIndex
Type: System.Int32
The new location of the column.
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.