NWC24ReadMsgAltName

C Specification

#include <revolution/nwc24.h>

NWC24Err NWC24ReadMsgAltName( const NWC24MsgObj* obj, u16* name, u32 length );

Description

Reads the alternate nickname of the sender set for the message.

Arguments

`obj`	The message object from which settings are to be extracted.
`name`	Pointer to the region where the alternate nickname is stored.
`length`	Size of the region specified by `name`.

Return Values

NWC24_OK: Normal exit (the alternate nickname is returned in *name).
NWC24_ERR_LIB_NOT_OPENED: Library not open.
NWC24_ERR_PROTECTED: Message object cannot be read.
NWC24_ERR_OVERFLOW: Alternate nickname set for the message object overflowed the buffer.
NWC24_ERR_FILE_*: Internal file operation error.

Revision History

2006/10/06 Initial version.