NWC24SetMsgAltName

C Specification

#include <revolution/nwc24.h>

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

Description

Sets an alternate nickname for the message sender.
Normally, the nickname registered in the friend roster on the Wii is used for the name of the sender when a message is displayed on the Wii Message Board. However, an alternate name can be set here for times when the display of a different name is desired, such as when sending a message from an application.

The following conditions must be fully satisfied in order for the alternate nickname to be displayed correctly on the Wii Message Board:

• Character code is UTF-16BE format.
• Maximum of 35 characters.
• String includes 0x0000 as the termination character (this is counted in the total number of characters).
• Up to one linefeed, using the UTF-16BE LF code (0x000A). (This is also counted in the total number of characters.)
• A maximum of 17 characters that can be displayed on a single line. (If no linefeed is used, the string will be wrapped automatically at 17 characters, and it may not display properly, depending on the character width.)

Although this feature was originally created for use with the Wii Message Board, it can also be used for exchanging messages between applications.

Arguments

Return Values

NWC24_OK: Normal termination.
NWC24_ERR_PROTECTED: Cannot change message object.
NWC24_ERR_NOT_SUPPORTED: A message type other than that exchanged between Wii consoles has been specified for obj.
NWC24_ERR_FULL: An alternate nickname is already set.
NWC24_ERR_INVALID_VALUE: A value greater than the maximum number of characters for an alternate nickname has been specified for length.
NWC24_ERR_NULL: The name value is a null pointer, or the alternate nickname string is empty.

See Also

NWC24InitMsgObj

Revision History

2007/04/03 Revised conditions for correct display on Wii Message Board.
2006/10/06 Initial version.

CONFIDENTIAL