NWC24GetMsgAttachedPtr

C Specification

#include <revolution/nwc24.h>
NWC24Err NWC24GetMsgAttachedPtr(
    const NWC24MsgObj* obj,
    u32                index,
    const char**       data
);

Description

Returns a message object setting (a pointer to the attached binary 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 NWC24ReadMsgAttached(), which references the message body.))

Arguments

obj Message object from which settings are to be extracted.
index Index for specifying one of multiple binary attachments.
data Pointer to the location storing the extracted information, namely, the start address of the attached binary source data.

Return Values

NWC24_OK: Normal exit (value returned in *data).
NWC24_ERR_NULL: The attached binary specified by index has not yet been set.
NWC24_ERR_INVALID_VALUE: The value of index is invalid.
NWC24_ERR_PROTECTED: Could not access the message object (for example, if it's already stored in the box).

See Also

Revision History

2007/01/16 Initial version.

CONFIDENTIAL