NWC24ReadMsgToId

C Specification

#include <revolution/nwc24.h>
NWC24Err NWC24ReadMsgToId( const NWC24MsgObj* obj, u32 index, NWC24UserId* userId );

Description

Reads one of the message recipient IDs from the message data.
This is valid only for objects storing information for messages exchanged between Wii consoles.
The actual message data must be opened and its text extracted because the recipient information is not included in the message object itself.

Arguments

obj Message object from which settings are to be extracted.
index Index for selecting one among multiple recipients.
userId Pointer to the location storing the extracted information (the recipient ID).

Return Values

NWC24_OK: Normal exit (value returned in userId).
NWC24_ERR_LIB_NOT_OPENED: Library not open.
NWC24_ERR_PROTECTED: Message object cannot be read.
NWC24_ERR_NOT_SUPPORTED: Unsupported message object specified by obj.
NWC24_ERR_NOT_FOUND: Specified index value is equal to or greater than the number of addresses set for the message object.
NWC24_ERR_NULL: Message data not set.
NWC24_ERR_OVERFLOW: Recipient addresses set for the message object overflowed the buffer.
NWC24_ERR_FORMAT: Format error for the recipient address set for the message object.
NWC24_ERR_FILE_*: Internal file operation error.

See Also

Revision History

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


CONFIDENTIAL