osGetMailboxInfo function

Declaration:

BOOL osGetMailBoxInfo(
  HANDLE Handle,
  SIZE *NextSize,
  INDEX *Count
);

Parameters:

Handle

The handle to the mailbox object.

NextSize

A pointer to a variable that will receive the size of the next available message in the mailbox.

Count

A pointer to a variable that will receive the total count of messages currently stored in the mailbox.

Return value:

TRUE on success; FALSE on failure. Call the osGetLastError function to retrieve extended error information.

Description:

This function retrieves fundamental status information regarding the specified mailbox.

For further details on mailbox functionality, refer to the mailbox objects section.

This function is available only when both the OS_USE_MAILBOX and OS_MBOX_GET_INFO_FUNC constants are set to 1.

Version:	1.0
Header file:	OS_Mailbox.h (include OS_API.h)
See also:	BOOL, FALSE, HANDLE, INDEX, mailboxes, OS_MBOX_GET_INFO_FUNC, OS_USE_MAILBOX, osGetLastError, SIZE, TRUE

SpaceShadow documentation