NWC24ReadMsgSubject

C Specification

#include <revolution/nwc24.h>

NWC24Err NWC24ReadMsgSubject(
    const NWC24MsgObj* obj,
    char*              buffer,
    u32                bufSize
);

Description

Reads the subject of the message from the message data. The actual message data is opened and the string is extracted into memory.
The string to be retrieved is terminated with '\0' (NULL character).

Arguments

`obj`	The message object from which settings are to be extracted.
`buffer`	Pointer to the region where the read string is stored.
`bufSize`	The size of the region specified by `buffer`.

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: Subject title set for the message object overflowed the buffer.
NWC24_ERR_FILE_*: Internal file operation error.

Revision History

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