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>NWC24SetMsgLedPattern</TITLE>
7<LINK rel="stylesheet" type="text/css" href="../../CSS/revolution.css">
8</HEAD>
9<BODY>
10<H1>NWC24SetMsgLedPattern</H1>
11
12<H2>C Specification</H2>
13<DL>
14<DD><PRE><CODE>#include &lt;revolution/nwc24.h&gt;</CODE></PRE>
15<DD><PRE><CODE><A HREF="../Types/NWC24Err.html">NWC24Err</A> NWC24SetMsgLedPattern( <A HREF="../Types/NWC24MsgObj.html">NWC24MsgObj</A>* <EM>obj</EM>, u16 <EM>pattern</EM> );</CODE></PRE>
16</DL>
17
18<H2>Description</H2>
19<P>
20Embeds a specification in the message for lighting the LED upon arrival. Messages configured using this function cause the slot LED on the console to light according to the specified pattern when the message is received by the other player's Wii console.
21</P>
22<P>
23<STRONG>Caution:</STRONG><BR>
24<UL>
25<LI>The only messages in which this LED specification can be set are messages of type <A HREF="../Types/NWC24MsgType.html"><CODE>NWC24_MSGTYPE_WII_MENU</CODE></A> or <A HREF="../Types/NWC24MsgType.html"><CODE>NWC24_MSGTYPE_WII_MENU_SHARED</CODE></A> that are to be sent to the Wii Message Board.</LI>
26<LI>The LED will not light on consoles where the LED light feature has been turned off.</LI>
27<LI>The LED does not light when a message is received while running an application in which lighting LED is prohibited with <A href="../Misc/NWC24EnableLedNotification.html"><CODE>NWC24EnableLedNotification</CODE></A>.</LI>
28<LI>Sometimes the LED will not light, depending on the time at which the message is received.</LI>
29<LI>The LED does not light for messages directly output to one's own inbox for consoles running version 3.0 or earlier of Wii Menu.</LI>
30</UL>
31</P>
32
33<H2>Arguments</H2>
34<TABLE border="1" cellpadding="3" cellspacing="0.1">
35  <TR>
36<TD width="120" bgcolor="#ffffe8"><code><em><strong>obj</strong></em></code></TD>
37    <TD width="520">
38Pointer to the message object to be set.
39    </TD>
40  </TR>
41  <TR>
42<TD width="120" bgcolor="#ffffe8"><code><em><strong>pattern</strong></em></code></TD>
43    <TD width="520">
44The lighting pattern number. (The only pattern number currently usable is the value defined as <CODE>NWC24_LED_APP_DEFAULT</CODE>. Operations are not guaranteed if any other number is specified.)
45    </TD>
46  </TR>
47</TABLE>
48
49<h2>Return Values</h2>
50<P>
51<code>NWC24_OK</code>: Normal exit.<BR> <code>NWC24_ERR_PROTECTED</code>: Cannot change message object.<BR> <code>NWC24_ERR_INVALID_VALUE</code>: Invalid value specified for <code><em><strong>pattern</strong></em></code>.<BR> <code>NWC24_ERR_NOT_SUPPORTED</code>: LED light specification uses an unsupported message format.
52</P>
53
54<H2>See Also</H2>
55<P>
56<A href="NWC24InitMsgObj.html"><CODE>NWC24InitMsgObj</CODE></A>, <A href="NWC24CommitMsg.html"><CODE>NWC24CommitMsg</CODE></A> <A href="../Misc/NWC24EnableLedNotification.html"><CODE>NWC24EnableLedNotification</CODE></A>
57</P>
58
59<H2>Revision History</H2>
60<P>
612007/11/07 Changed the caution specific to messages output to own inbox in conjunction with present specifications.
62<BR> 2007/05/24 Revised the macro name<BR>2007/05/03 Changed the macro to specify a pattern number  <BR>2007/03/27 Added message type restrictions to the <CODE>Caution</CODE> section<BR>2007/01/29 Added link to <CODE>NWC24EnableLedNotification</CODE><BR>2006/12/05 Initial version.</P>
63
64<hr><p>CONFIDENTIAL</p></body>
65</HTML>