NWC24CommitMsg

Syntax

#include <revolution/nwc24.h>

NWC24Err NWC24CommitMsg( NWC24MsgObj* obj );

Description

Creates message data reflecting the content of the configured message object and places it in the outbox.

The data set with a function such as NWC24SetMsgText() is referenced and the message data is created. This means that you may deallocate the memory area storing these data after calling this function.

The NWC24SetMsg* type functions can no longer be called for message objects that were created by calling NWC24CommitMsg() once to create a message because it contains the information for referencing the newly created message. When creating a new message, NWC24InitMsgObj() will need to be called again to initialize the object.

Arguments

obj Pointer to the message object set for message creation

Return Values

NWC24_OK: Normal exit.
NWC24_ERR_LIB_NOT_OPENED: The library has not been opened.
NWC24_ERR_PROTECTED: The message object has not been properly set.
NWC_24_ERR_OVERFLOW: The data size exceeds the limit that can be sent as a message.
NWC24_ERR_FULL: Data cannot be stored because Outbox is full.
NWC24_ERR_NULL: An addressee has not been set for the created message.
NWC24_ERR_INVALID_VALUE: The number of addressees or attached binaries for the created message has exceeded the limit.
NWC24_ERR_FORMAT: Some field violates the format.
NWC24_ERR_NOMEM: Insufficient buffer during internal processing.
NWC24_ERR_FILE_*: Error with internal file operations.
NWC24_ERR_NAND_CORRUPT: Fatal corruption of Wii console NAND memory.
NWC24_ERR_INTERNAL_VF: VF error due to internal function call.

If one of the following values is returned, you can immediately call the NWC24GetErrorCode function to get the 6-digit error code corresponding to the error that occurred.

File-related errors: NWC24_ERR_FILE_***, NWC24_ERR_BROKEN, NWC24_ERR_NAND_CORRUPT, and NWC24_ERR_INTERNAL_VF.
Outbox is full: NWC24_ERR_FULL.

Revision History

2008/01/17 Added return values that had been omitted.
2007/04/05 Added a description for getting the error code.
2006/10/06 Updated the list of return values.
2006/08/01 Initial version.