Share via

  • Article

IDTSInputCollection100.GetObjectIndexByID Method

Retrieves the index of the IDTSInput100 object in a collection.

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

Syntax

'Declaration
Function GetObjectIndexByID ( _
    lID As Integer _
) As Integer
'Usage
Dim instance As IDTSInputCollection100
Dim lID As Integer
Dim returnValue As Integer

returnValue = instance.GetObjectIndexByID(lID)

int GetObjectIndexByID(
    int lID
)

int GetObjectIndexByID(
    [InAttribute] int lID
)

abstract GetObjectIndexByID : 
        lID:int -> int 

function GetObjectIndexByID(
    lID : int
) : int

Parameters

Return Value

Type: System.Int32
An Integer that indicates the location of the item in the index.

Remarks

The GetObjectIndexByID method retrieves the index in the input collection of the input having the ID specified by the lID parameter. If an input with the specified ID is not found in the collection, a Microsoft.SqlServer.Dts.HResults.DTS_E_OBJECTNOTINHASHTABLE exception occurs.