INtime SDK Help
FlushRtQueue
INtime SDK v7.1 > About INtime > INtime Kernel > Message Queues > FlushRtQueue

Discards all messages currently on the queue without receiving them.

BOOLEAN FlushRtQueue(RTHANDLE hQueue); 

Parameters

hQueue
A handle for a valid queue object.

Returns

Returns TRUE on success. Returns FALSE on failure. Call GetLastRtError() to find the failure status. Possible status values include:
E_EXIST The hQueue parameter does not refer to an existing object
E_TYPE The hQueue parameter does not refer to a valid queue object.

Requirements

Versions Defined in Include Link to
INtime 5.0 intime/rt/include/rtbase.h rt.h rt.lib
See Also