NWC24GetMsgIdList

C Specification

#include <revolution/nwc24.h>

NWC24Err NWC24GetMsgIdList( NWC24MsgBoxId mboxId, u32* idTable, u32 size );

Description

Returns a list of message IDs held in the specified message box (outbox or inbox).

Arguments

`mboxId`	Message box type (`NWC24_SEND_BOX/NWC24_RECV_BOX`).
`idTable`	Pointer to the array where the message ID list is returned.
`size`	The number of elements in the array specified by `idTable`.

Return Values

NWC24_OK: Normal exit. (The ID list is formed in the array indicated by *.)idTable).
NWC24_ERR_LIB_NOT_OPENED: Library not open.
NWC24_ERR_INVALID_VALUE: A value other than NWC24_SEND_BOX or NWC24_RECV_BOX was specified in mboxId.
NWC24_ERR_FULL: The number of message IDs exceeds size.
NWC24_ERR_FILE_*: Internal file operation related error.
NWC24_ERR_VER_MISMATCH: Message box version error.

Revision History

2007/05/03 Corrected the explanation of size to be 'the number of elements in the array'
2006/10/06 Updated the list of return values.
2006/08/01 Initial version.