osMailboxPost function
Declaration:
BOOL osMailboxPost(
  HANDLE Handle
  PVOID Buffer,
  SIZE Size
);
Parameters:
Handle

Handle of mailbox object.

Buffer

Pointer to buffer with a message to be written.

Size

Size of the message.

Return value:

Returns number of successfully transferred bytes or zero on failure. Use osGetLastError function to obtain extended error information.

Description:

Function stores a message at the end of mailbox. The number of messages that can be stored in a mailbox is unlimited. Function fails, in case of out of memory.

For more information on mailbox see the mailbox objects section.

Function is available only, when the values of OS_USE_MAILBOX and OS_MBOX_POST_PEND_FUNC constants are set to 1.

Version:1.0
Header file:OS_Mailbox.h (include OS_API.h)
See also: BOOL, FALSE, HANDLE, mailboxes, OS_MBOX_POST_PEND_FUNC, OS_USE_MAILBOX, osCreateMailbox, osGetLastError, osMailboxPost, osMailboxPeek, PVOID, SIZE, TRUE
SpaceShadow documentation