1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html>
3
4<head>
5<META http-equiv="Content-Type" content="text/html; charset=windows-1252">
6<META name="GENERATOR" content="IBM WebSphere Studio Homepage Builder Version 8.0.2.0 for Windows">
7<META http-equiv="Content-Style-Type" content="text/css">
8<title>WM_SetGameInfo</title>
9<LINK rel="stylesheet" href="../../css/nitro.css" type="text/css">
10</head>
11
12<body>
13
14<h1 align="left">WM_SetGameInfo <img src="../../image/NTR.gif"><img src="../../image/TWL.gif"></H1>
15<h2>Syntax</h2>
16<dl>
17  <dd><PRE><CODE>#include &lt;nitro/wm.h&gt;
18
19<A href="WMErrCode.html">WMErrCode</A> WM_SetGameInfo(
20        <A href="WMCallbackFunc.html">WMCallbackFunc</A>  callback ,
21        const u16*      userGameInfo ,
22        u16             userGameInfoSize ,
23        u32             ggid,
24        u16             tgid,
25        u8              attr
26);
27</CODE></PRE></dd>
28</dl>
29
30<h2>Arguments</h2>
31<TABLE width="100%">
32  <tbody>
33    <TR>
34<TD width="200"><CODE>callback</CODE></TD>
35<TD width="800">Designates the callback function to call when the asynchronous process completes. This callback is called from within the interrupt handler.</TD>
36    </TR>
37    <TR>
38<TD width="200"><CODE>userGameInfo</CODE></TD>
39<TD width="800">Specifies the pointer to user game information.</TD>
40    </TR>
41    <TR>
42<TD width="200"><CODE>userGameInfoSize</CODE></TD>
43<TD width="800">Specifies the size of user game information. A maximum of 112 bytes can be specified.</TD>
44    </TR>
45    <TR>
46<TD width="200"><CODE>ggid</CODE></TD>
47<TD width="800">Specifies the game group ID.</TD>
48    </TR>
49    <TR>
50<TD width="200"><CODE>tgid</CODE></TD>
51<TD width="800">Specifies a temporary group ID.</TD>
52    </TR>
53    <TR>
54<TD width="200"><CODE>attr</CODE></TD>
55<TD width="800">Specifies attributes such as: receiving entry and DS download play permitted.</TD>
56    </TR>
57  </tbody>
58</table>
59
60<h2>Return Values</h2>
61<p>Returns the results of the <CODE><A href="WMErrCode.html">WMErrCode</A></CODE> enumerated type process.</p>
62
63<H2>Description</H2>
64<P>Reconfigures the game-specific information sent out by the beacon. This function can be executed only if the WM is in the <A href="wm_state_diagram.html"><code>PARENT</code></A> or <A href="wm_state_diagram.html"><code>MP_PARENT</code></A> state. If the return value is <CODE>WM_ERRCODE_OPERATING</CODE>, a callback is generated after the information reconfiguration process is complete. The <A href="WM_SetParentParameter.html"><code>WM_SetParentParameter</code></A> function sets the initial values, and this function modifies the values.</P>
65<P>The argument <em><strong><code>attr</code></strong></em> is expressed as the logical sum of the following:</P>
66<TABLE>
67  <TBODY>
68    <TR>
69<TD bgcolor="#eeeeee">WM_ATTR_FLAG_ENTRY</TD>
70<TD bgcolor="#eeeeee">&quot;Receiving entry&quot; flag</TD>
71    </TR>
72    <TR>
73<TD bgcolor="#eeeeee">WM_ATTR_FLAG_MB</TD>
74<TD bgcolor="#eeeeee">&quot;Download play possible&quot; flag</TD>
75    </TR>
76    <TR>
77<TD bgcolor="#eeeeee"><DEL>WM_ATTR_FLAG_KS</DEL></TD>
78<TD bgcolor="#eeeeee"><DEL>Key sharing.</DEL>Not currently used. (Note: Be sure to disable this bit.)</TD>
79    </TR>
80    <TR>
81<TD bgcolor="#eeeeee"><DEL>WM_ATTR_FLAG_CS</DEL></TD>
82<TD bgcolor="#eeeeee"><DEL>Continuation communication mode.</DEL>Not currently used.</TD>
83    </TR>
84  </TBODY>
85</TABLE>
86
87<h2>See Also</h2>
88<p><a href="WM_SetParentParameter.html"><code>WM_SetParentParameter</code></a><BR> <a href="WM_StartParent.html"><code>WM_StartParent</code></a></p>
89
90<H2>Revision History</H2>
91<P>
922008/12/18 Deleted a mistake in the description of arguments.<BR>2006/02/20 Changed argument names.<BR>2005/12/08 Deleted a description of the cache ring.<BR>2005/06/08 Added the fact that the callback is called from the interrupt handler.<br>2004/10/22 Changed the type of return values.<BR>2004/09/24 Added to and revised the Description.<BR>2004/08/02 Standardized structure names.<BR>2004/07/29 Made additions to the Description.<BR>2004/07/23 Initial version.<BR>
93</P>
94<hr><p>CONFIDENTIAL</p></body>
95</html>
96