User Manual

RK-5409-5 Reference Kit User’s Guide 4-15
iBeanAPI.h
5. ibApi_GetDeviceList()
ibApi_FUNC ibApi_GetDeviceList(
ibApi_APIHANDLE api_hdl,
ibApi_GROUPID network,
ibApi_DEVICETYPE device_type
ibApi_DEVICEID devices[],
ibAPI_UINT32 devices_size
);
This function retrieves the ID’s of the devices in the network. The device_type parameter is a
bitwise OR of the ibApi_DEVICETYPE constants that filters the result. (To retrieve all devices,
use ibApi_DEVICETYPE_ANY.)
Parameters:
param api_hdl: (input) API handle returned from ibApi_Open().
network: (input) Group ID of the network.
device_type: (input) Device type filter.
devices: (output) Pointer to an array of device IDs.
devices_size: (input) Maximum number of device IDs that the devices array can hold.
Return Value:
The actual number of devices (which can exceed devices_size if the written data was
truncated), or an error code (<0) if unsuccessful.
6. ibApi_GetDeviceInfo()
ibApi_FUNC ibApi_GetDeviceInfo(
ibApi_APIHANDLE api_hdl,
ibApi_DEVICEID device_id,
ibApi_DEVICEINFO * device_info
);
This function retrieves various static device attributes that are predetermined at
manufacturing time. Thus, these values only need to be queried once for a particular device.
See ibApi_DEVICEINFO above for details.
Note: To avoid memory corruption, the size of (ibApi_DECVICEINFO)
must be allocated to the “struct_size” field prior to calling this function.
Parameters:
api_hdl: (input) API handle returned from ibApi_Open().
device_id: (input) ID of device to be accessed.
device_info: (output) Pointer to variable storing the result.
Return Value:
An ibApi_RESULT_SUCCESS if successful, error code (<0) if not.