NWC24ReadMsgText

C Specification

#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 sender 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 to be 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 is not open.
NWC24_ERR_PROTECTED: Cannot read message object.
NWC24_ERR_NULL: Message data not set.
NWC24_ERR_OVERFLOW: Message body set for message object overflowed buffer.
NWC24_ERR_NOT_SUPPORTED: Unsupported character code or MIME encoding type set for message object.
NWC24_ERR_FILE_*: Internal file operation error.

Revision History

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