1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 2<HTML> 3<HEAD> 4<META http-equiv="Content-Type" content="text/html; charset=windows-1252"> 5<META http-equiv="Content-Style-Type" content="text/css"> 6<TITLE>NWC24SetMsgAltName</TITLE> 7<LINK rel="stylesheet" type="text/css" href="../../CSS/revolution.css"> 8</HEAD> 9<BODY> 10<H1>NWC24SetMsgAltName</H1> 11 12<H2>C Specification</H2> 13<DL> 14<DD><PRE><CODE>#include <revolution/nwc24.h></CODE></PRE> 15<DD><PRE><CODE><A HREF="../Types/NWC24Err.html">NWC24Err</A> NWC24SetMsgAltName( <A HREF="../Types/NWC24MsgObj.html">NWC24MsgObj</A>* <EM>obj</EM>, const u16* <EM>name</EM>, u32 <EM>length</EM> );</CODE></PRE> 16</DL> 17 18<H2>Description</H2> 19<P> 20Sets an alternate nickname for the message sender.<BR>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. 21</P> 22 23<P> 24The following conditions must be fully satisfied in order for the alternate nickname to be displayed correctly on the Wii Message Board: 25</P> 26 27<UL> 28<LI> Character code is UTF-16BE format. 29<LI> Maximum of 35 characters. 30<LI> String includes 0x0000 as the termination character (this is counted in the total number of characters). 31<LI> Up to one linefeed, using the UTF-16BE LF code (0x000A). (This is also counted in the total number of characters.) 32<LI> 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.) 33</UL> 34 35<P> 36Although this feature was originally created for use with the Wii Message Board, it can also be used for exchanging messages between applications. 37</P> 38 39<H2>Arguments</H2> 40<TABLE border="1" cellpadding="3" cellspacing="0.1"> 41 <TR> 42<TD width="120" bgcolor="#ffffe8"><code><em><strong><em><strong><code>obj</code></strong></em></strong></em></code></TD> 43 <TD width="520"> 44Pointer to the message object to be set. 45 </TD> 46 </TR> 47 <TR> 48<TD width="120" bgcolor="#ffffe8"><code><em><strong>name</strong></em></code></TD> 49 <TD width="520"> 50Alternate nickname to be set for messages. 51 </TD> 52 </TR> 53 <TR> 54<TD width="120" bgcolor="#ffffe8"><code><em><strong>length</strong></em></code></TD> 55 <TD width="520"> 56Length of the string specified by <code><em><strong>name</strong></em></code>. 57 </TD> 58 </TR> 59</TABLE> 60 61<h2>Return Values</h2> 62<P> 63<code>NWC24_OK</code>: Normal termination.<BR> <code>NWC24_ERR_PROTECTED</code>: Cannot change message object.<BR> <code>NWC24_ERR_NOT_SUPPORTED</code>: A message type other than that exchanged between Wii consoles has been specified for <code><em><strong>obj</strong></em></code>.<BR> <code>NWC24_ERR_FULL</code>: An alternate nickname is already set.<BR> <code>NWC24_ERR_INVALID_VALUE</code>: A value greater than the maximum number of characters for an alternate nickname has been specified for <code><em><strong>length</strong></em></code>.<BR> <code>NWC24_ERR_NULL</code>: The <code><em><strong>name</strong></em></code> value is a null pointer, or the alternate nickname string is empty.<BR> 64</P> 65 66<H2>See Also</H2> 67<P> 68<A href="../Message/NWC24InitMsgObj.html"><CODE>NWC24InitMsgObj</CODE></A> 69</P> 70 71<H2>Revision History</H2> 72<P> 732007/04/03 Revised conditions for correct display on Wii Message Board.<BR>2006/10/06 Initial version. 74</P> 75 76<hr><p>CONFIDENTIAL</p></body> 77</HTML>