Zen API

- Home
- Topics
- Types
- Files

All Classes Files Functions Variables Typedefs Friends Macros Modules Pages

kStatus kMsgQueue_PurgeEx | ( | kMsgQueue | queue,
|  | kMsgQueuePurgeOption | options
| ) |  |

Removes items from the queue using the specified options.

This method provides a flexible set of options for removing items from the queue. The options argument can be used to control the way in which item are disposed and counted.

This method is thread-safe.

Parameters

  queue | Queue object.
  options | Bitset of options.

Returns
  Operation status.

See also
  kMsgQueue_Purge, kMsgQueue_Clear