NWC24ReadMsgAttached

Syntax

#include <revolution/nwc24.h>

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

Description

Reads the binary data attached to the message from message data.
The actual message data is opened and the binary data is extracted into memory.

Arguments

`obj`	Message object from which settings are to be extracted.
`index`	Specifies one of multiple binary attachments.
`buffer`	A pointer to the region where the read binary data is stored.
`bufSize`	Size of the region specified by `buffer`.

Return Values

NWC24_OK: Normal exit.
NWC24_ERR_LIB_NOT_OPENED: Library not open.
NWC24_ERR_PROTECTED: Message object cannot be read.
NWC24_ERR_NOT_FOUND: A value equal to or greater than the number of binary data files attached to the message object has been specified for index.
NWC24_ERR_NULL: Attached binary data not set in the message data.
NWC24_ERR_BROKEN: Attached binary data is corrupted.
NWC24_ERR_FILE_*: Internal file operation error.
NWC24_ERR_NAND_CORRUPT: Fatal corruption in Wii console NAND memory.
NWC24_ERR_INTERNAL_VF: VF error caused by an internal function call.

Revision History

2008/01/17 Added return values that had been omitted.
2006/10/06 Updated the list of return values.
2006/08/01 Initial version.