User Manual

RK-5409-5 Reference Kit User’s Guide 4-21
iBeanAPI.h
15. ibApi_GetDevicePacketSequenceNumber()
ibApi_FUNC ibApi_GetDevicePacketSequenceNumber(
ibApi_APIHANDLE api_hdl,
ibApi_DEVICEID device_id
);
This function Gets a device packet sequence number that is carried by a upstream packet
sent from the device.
Parameters:
api_hdl: (input) API handle returned from ibApi_Open().
device_id: (input) The device id.
Return Value:
A 0 - 255 sequence number if successful, or an error code (<0) if failed.
16. ibApi_Block (void)
ibApi_FUNC ibApi_Block(void);
This function provides locking of shared data areas from within the application event
callback. This function is to be called prior to accessing the data record returned to the
callback function.
Parameters:
api_hdl: (input) API handle returned from ibApi_Open().
Return Value:
An ibApi_RESULT_SUCCESS if a device changed or an error code (<0) if unsuccessful.
17. ibApi_UnBlock (void)
ibApi_FUNC ibApi_UnBlock(void);
This function releases lock of shared data area from within the application event callback
function. This must be called prior to exiting the application event callback if the ibApi_Block
function was previously invoked.
Parameters:
api_hdl: (input) API handle returned from ibApi_Open().
device_id: (input) ID of the device to be accessed.
channel_index: (input) the channel index to access.
Return Value:
An ibApi_RESULT_SUCCESS if a device changed or an error code (<0) if unsuccessful.