NWC24GetNumMsgs

C Specification

#include <revolution/nwc24.h>
NWC24Err NWC24GetNumMsgs( NWC24MsgBoxId mboxId, u32* numMsgs );

Description

Returns the total number of messages maintained in the specified message box (Outbox/Inbox).

Arguments

mboxId Message box type (NWC24_SEND_BOX/NWC24_RECV_BOX).
numMsgs Pointer to the location returning the total number of messages.

Return Values

NWC24_OK: Normal termination (the total number of messages is returned in *numMsgs).
NWC24_ERR_LIB_NOT_OPENED: The library is not open.
NWC24_ERR_INVALID_VALUE: A value other than NWC24_SEND_BOX or NWC24_RECV_BOX was specified for mboxId.
NWC24_ERR_FILE_*: Internal file operation error.
NWC24_ERR_VER_MISMATCH: Message box version error.

See Also

Revision History

2006/10/06 Updated return value list.
2006/08/01 Initial version.

CONFIDENTIAL