TBApiGetRelativeDeviceFromHandle API Call

 

Description

Gets a device’s position in the list of defined controllers from a given device handle.

Parameters

Device handle.

Returns

Given a device handle the (zero based) position in the list is returned. A return value of -1 means that the requested device does not exist.

Notes

None.

See also

A number of functions require a device handle. The following family of functions provide valid device handle’s:

 

TBApiGetRelativeDevice

Get device handle from position

 

TBApiGetRelativeDeviceFromHandle

Get position from device handle

 

TBApiGetNamedDevice

Get device handle from named device

 

TBApiGetDeviceFromSegment

Get device handle from segment

 

TBApiGetRelativeDeviceNoHidden

Get device handle from position, excluding hidden (unplugged) devices

 

TBApiGetRelativeDeviceIncHidden

Get device handle from position, including hidden (unplugged) devices

 

Visual C++ Declaration/example

 

int TBAPI TBApiGetRelativeDeviceFromHandle( HTBDEVICE aDeviceHandle);

 

Visual Basic Declaration/example

 

Public Declare Function TBApiGetRelativeDeviceFromHandle Lib "TBapi" Alias "_DLL_TBApiGetRelativeDeviceFromHandle@4" (ByVal aDeviceHandle as Byte) as long