NWC24GetMsgTextPtr

C Specification

#include <revolution/nwc24.h>

NWC24Err NWC24GetMsgTextPtr(
    const NWC24MsgObj* obj,
    const char**       text
);

Description

Returns a message object setting (a pointer to the body text source data). This function is only enabled when creating a message during the period after the message is committed by calling NWC24CommitMsg() and before it is stored in the outbox. (In other situations, it is necessary to use NWC24ReadMsgText() or NWC24ReadMsgTextEx(), which reference the message body.))

Arguments

`obj`	The message object from which settings are to be extracted.
`text`	Pointer to the location storing the extracted information, namely, the start address of the body text source data.

Return Values

NWC24_OK: Ended normally (a value is returned in *text).
NWC24_ERR_NULL: The body text has not yet been set.
NWC24_ERR_PROTECTED: The message object could not be accessed (for example, if it's already stored in the box).

Revision History

2007/01/16 Initial version.