NWC24DeleteMsg

C Specification

#include <revolution/nwc24.h>

NWC24Err NWC24DeleteMsg( NWC24MsgBoxId mboxId, u32 msgId );

Description

Deletes the message with the specified ID from the specified message box.

A message can only be deleted by the same application that created that message.

Arguments

`mboxId`	Message box type (NWC24_SEND_BOX/NWC24_RECV_BOX)
`msgId`	ID of the message to be deleted

Return Values

NWC24_OK: Normal exit.
NWC24_ERR_LIB_NOT_OPENED: The library is not open.
NWC24_ERR_INVALID_VALUE: A value other than NWC24_SEND_BOX or NWC24_RECV_BOX has been specified for mboxId or the value of msgId is invalid.
NWC24_ERR_NOT_FOUND: The message given by msgId does not exist in the message box.
NWC24_ERR_PROTECTED: The application currently running cannot delete the specified message.
NWC24_ERR_FATAL: A fatal error occurred upon deleting the message.
NWC24_ERR_FILE_*: Error related to internal file operations.
NWC24_ERR_VER_MISMATCH: Message box version error.

Revision History

2007/09/04 Deleted some portions of text in line with change to specification.
2006/11/15 Added supplemental information and updated the list of return values.
2006/08/01 Initial version.