BM_ReadMultipleCanMessage

Read multiple CAN messages out of the given channel.

BMAPI BM_StatusTypeDef BM_ReadMultipleCanMessage (BM_ChannelHandle handle, BM_CanMessageTypeDef msg[], uint32_t *nmessages, int timeout, uint32_t channel[], uint32_t timestamp[])

Parameters

Direction	Name	Description
[in]	handle	Handle to the channel to read from.
[out]	data	A caller-allocated buffer to hold the CAN message array output, see BM_CanMessageTypeDef for details.
[in,out]	nmessages	Number of read messages, user shall initialize this param with the size (in messages) of the data buffer.
[in]	timeout	Timeout (in milliseconds) before the message is received successfully from the bus. Set any negative number (i.e. -1) to wait infinitely. Set 0 if you would like to receive asynchronously: read from BMAPI internal buffer and return immediately, use BM_WaitForNotifications() before reading.
[out]	channel	The source channel ID from which the message is received, starting from zero, could be NULL if not required.
[out]	timestamp	The device local high precision timestamp array in microseconds, when the message is physically transmitted on the CAN bus, could be NULL if not required.

Returns

Operation status, see BM_StatusTypeDef for details.

Note

This function is non-blocked, and thus will return BM_ERROR_QRCVEMPTY if not all messages are 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.