NWC24ReadMsgTextEx

Syntax

#include <revolution/nwc24.h>

NWC24Err NWC24ReadMsgTextEx(
    const NWC24MsgObj* obj,
    char*              buffer,
    u32                bufSize,
    char*              csNameBuf,
    u32                csNameSize
);

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 name of the character code (Charset) set by the recipient is also retrieved as a character string 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`.
`csNameBuf`	Pointer to the memory storing the name of the character code that was read.
`csNameSize`	Size of the region specified by `csNameBuf`.

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/12/05 Initial version.