NWC24GetMsgObj

C Specification

#include <revolution/nwc24.h>

NWC24Err NWC24GetMsgObj( NWC24MsgObj* obj, NWC24MsgBoxId mboxId, u32 msgId );

Description

Gets the meta-information about the message with the specified ID in the specified message box and expands that information into an NWC24MsgObj object.

NWC24_ERR_HIDDEN is returned without expanding data for messages that cannot be opened from the application currently running. (This occurs, for example, in the case of messages that have been created by another application with NWC24_MSGTYPE_WII_APP_HIDDEN or HWC24_MSGTYPE_WII_MENU specified.)

Arguments

`obj`	Pointer to the object storing the meta-data of the retrieved message.
`mboxId`	Message box type (NWC24_SEND_BOX/NWC24_RECV_BOX).
`msgId`	ID of the retrieved message.

Return Values

NWC24_OK: Normal exit (message data is unpacked into *obj).
NWC24_ERR_HIDDEN: The message cannot be accessed from the application currently running.
NWC24_ERR_LIB_NOT_OPENED: Library not open.
NWC24_ERR_INVALID_VALUE: A value other than NWC24_SEND_BOX or NWC24_RECV_BOX has been specified for mboxId.
NWC24_ERR_NOT_FOUND: The message given by msgId does not exist in the message box.
NWC24_ERR_FILE_*: Error related to internal file processing.
NWC24_ERR_VER_MISMATCH: Message box version error.

Revision History

2006/11/09 Added description about HIDDEN errors.
2006/10/06 Updated return value list.
2006/08/01 Initial version.