canFlushReceiveQueue

canFlushReceiveQueue

Syntax

#include <canlib.h> canStatus canFlushReceiveQueue(int handle);

Description

This function removes all received messages from the handle's receive queue.

Input Parameters

handle: A handle to an open circuit.

Output Parameters

None.

Return Value

canOK (zero) if success
canERR_xxx (negative) if failure.

Notes

Other handles open to the same channel are not affcted by this operation. That is, only the messages belonging to the handle you are passing to canFlushReceiveQueue are discarded.
This call has the same effect as calling canIoCtl with a function code of canIOCTL_FLUSH_RX_BUFFER.

Related Topics

canFlushReceiveQueue
canFlushTransmitQueue