osClearMailbox function
Declaration:
BOOL osClearMailbox(
  HANDLE Handle
);
Parameters:
Handle

Handle of mailbox object.

Return value:

TRUE on success or FALSE on failure. Use osGetLastError function to obtain extended error information.

Description:

Function removes all messages from the mailbox. All messages stored in the mailbox, have allocated a memory buffer. Once the function is performed, all messages are removed from the mailbox and the mailbox can be used by other tasks. At this time, all memory buffers are released one by one by a task that performs an osClearMailbox function.

Function is available only, when the value of OS_USE_MAILBOX and OS_MBOX_CLEAR_FUNC constants are set to 1. For more information on the mailbox see the mailbox objects section.

Version:1.0
Header file:OS_Mailbox.h (include OS_API.h)
See also: BOOL, FALSE, HANDLE, mailboxes, OS_MBOX_CLEAR_FUNC, OS_USE_MAILBOX, osGetLastError, TRUE
SpaceShadow documentation