osMailboxPost function

Declaration:

BOOL osMailboxPost(
  HANDLE Handle
  PVOID Buffer,
  SIZE Size
);

Parameters:

Handle

The handle to the mailbox object.

Buffer

A pointer to the buffer containing the message to be written.

Size

The size of the message in bytes.

Return value:

Returns the number of successfully transferred bytes, or zero on failure. Call the osGetLastError function to retrieve extended error information.

Description:

This function appends a message to the end of the mailbox. The number of messages that can be stored within a mailbox is limited only by available system memory. The function will fail if the system is unable to allocate sufficient memory for the message.

For more information on mailbox functionality, refer to the mailbox objects section.

This function is available only when both the 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