NWC24ReadMsgText

Syntax

#include <revolution/nwc24.h>

NWC24Err NWC24ReadMsgText(
    const NWC24MsgObj* obj,
    char*              buffer,
    u32                bufSize,
    NWC24Charset*      charset,
    NWC24Encoding*     encoding
);

Description

Reads the string data that represents body text of the message from message data. The actual message data is opened and the string is extracted into memory. The character code (Charset) and MIME encoding information set by the recipient are also retrieved at the same time.

The string to be retrieved is terminated with '\0' (NULL character).

Arguments

`obj`	Message object from which settings are to be extracted.
`buffer`	Pointer to the region where the read string is stored.
`bufSize`	Size of the region specified by `buffer`.
`charset`	Pointer storing the type of character code that was read.
`encoding`	Pointer storing the type of MIME encoding that was read.

Return Values

NWC24_OK: Normal exit.
NWC24_ERR_LIB_NOT_OPENED: Library not open.
NWC24_ERR_PROTECTED: Cannot read the message object.
NWC24_ERR_NULL: Message data not set.
NWC24_ERR_OVERFLOW: The message body set for the message object overflowed the buffer.
NWC24_ERR_NOT_SUPPORTED: An unsupported character code or a MIME encoding type set for the message object.
NWC24_ERR_FILE_*: Internal file operation error.
NWC24_ERR_NAND_CORRUPT: Fatal corruption in Wii console NAND memory.
NWC24_ERR_INTERNAL_VF: VF error caused by an internal function call.

Revision History

2008/01/17 Added return values that had been omitted.
2006/10/06 Updated the list of return values.
2006/08/01 Initial version.