IDTSExternalMetadataColumnCollection90.SetIndex Method

Article
12/03/2008

Changes the location in the collection of an IDTSExternalMetadataColumn90 object.

Namespace: Microsoft.SqlServer.Dts.Pipeline.Wrapper
Assembly: Microsoft.SqlServer.DTSPipelineWrap (in microsoft.sqlserver.dtspipelinewrap.dll)

Syntax

'Declaration
<DispIdAttribute(19)> _
Sub SetIndex ( _
    <InAttribute> lOldIndex As Integer, _
    <InAttribute> lNewIndex As Integer _
)

[DispIdAttribute(19)] 
void SetIndex (
    [InAttribute] int lOldIndex,
    [InAttribute] int lNewIndex
)

[DispIdAttribute(19)] 
void SetIndex (
    [InAttribute] int lOldIndex, 
    [InAttribute] int lNewIndex
)

/** @attribute DispIdAttribute(19) */ 
void SetIndex (
    /** @attribute InAttribute() */ int lOldIndex, 
    /** @attribute InAttribute() */ int lNewIndex
)

DispIdAttribute(19) 
function SetIndex (
    lOldIndex : int, 
    lNewIndex : int
)

Parameters

lOldIndex
The current location in the collection of the column.

lNewIndex
The new location of the column.

Remarks

lOldIndex and lNewIndex are zero-based parameters. The method moves the IDTSExternalMetadataColumn90 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.

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