BM_Read

Read any message/event out of the given channel.

BMAPI BM_StatusTypeDef BM_Read (BM_ChannelHandle handle, BM_DataTypeDef *data)

Parameters

Direction	Name	Description
[in]	handle	Handle to the channel to read from.
[out]	data	A caller-allocated buffer to hold the message/event output, see BM_DataTypeDef for details.

Returns

Operation status, see BM_StatusTypeDef for details.

Note

This function is non-blocked, and thus will return BM_ERROR_QRCVEMPTY if no message is received. Please use notifications to wait for Rx events and then read message/event out of BMAPI internal RX buffer, otherwise you could also poll the device periodically.

---

This reference follows the current BUSMUST BMAPI SDK. For an installed package, its bundled header and help files define the exact version-specific contract.