NWC24GetMsgSize

C Specification

#include <revolution/nwc24.h>
NWC24Err NWC24GetMsgSize( const NWC24MsgObj* obj, u32* size );

Description

Returns the total size of the message. The value obtained with this function is the data size when the message is actually saved to the message box or sent/received, after MIME encoding of attached data has been done and headers have been added.

When creating a new message, this value cannot be obtained until the message is committed by calling NWC24CommitMsg.

Arguments

obj The message object from which settings are to be extracted.
size Pointer to the location storing the extracted information (the total size of the message).

Return Values

NWC24_OK: Ended normally (value returned in *size).
NWC24_ERR_PROTECTED: Either the message object could not be accessed, or the size was not determined because it was not yet committed.

See Also

NWC24CommitMsg

Revision History

2007/01/30 Initial version.


CONFIDENTIAL