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 http-equiv="Content-Style-Type" content="text/css">
7<LINK rel="stylesheet" type="text/css" href="../CSS/revolution.css">
8<title>MPDLConfig</title>
9</head>
10
11<body>
12
13<h1>MPDLConfig</h1>
14
15<h2>Definitions</h2>
16<dl><dd>
17<pre><code>
18#include &lt;revolution/mpdl.h&gt;
19
20typedef struct MPDLConfig
21{
22    void*       (*alloc)(u32 size);
23    void        (*free) (void* ptr);
24    OSPriority  threadPriority;
25    u32         ggid;
26    u32         tgid;
27    u32         channel;
28
29    u8          serverColor;
30    const u16  *serverName;
31    const u16  *programTitle;
32    const u16  *programComment;
33    u32         programMaxEntry;
34    const u8   *programImage;
35    const void *bannerCharacter;
36    const void *bannerPalette;
37
38    void       *internalWork1;
39    void       *internalWork2;
40    BOOL        entry_flag;
41    BOOL        mb_flag;
42    u32         bitmap;
43    MPConfig    mpConfig[1];
44}
45MPDLConfig;
46</code></pre>
47</dd></dl>
48
49<H2>Description</H2>
50<p>
51The MPDLConfig structure is used to store MPDL library settings and configuration information for the MP library that is automatically controlled internally.
52</p>
53<TABLE border="1">
54  <TBODY>
55      <tr>
56<th><strong>Member</strong></th>
57<th><strong>Description</strong></th>
58      </tr>
59    <tr>
60<td colspan="2">Members used &quot;as is&quot; for the MP library's <a href="../mp/MPConfig.html">MPConfig</a></td>
61    </tr>
62    <TR>
63<td valign="top" width="120" bgcolor="#ffffe8"><em><strong>alloc</strong></em></td>
64<TD width="520">Function to allocate memory for use inside the project.</TD>
65    </TR>
66    <TR>
67<td valign="top" width="120" bgcolor="#ffffe8"><em><strong>free</strong></em></td>
68<TD width="520">Function to deallocate memory used inside the project.</TD>
69    </TR>
70    <TR>
71<td valign="top" width="120" bgcolor="#ffffe8"><em><strong>threadPriority</strong></em></td>
72<TD width="520">Priority level of MP working thread.<br>Several working threads are created having this priority level or lower.  </TD>
73    </TR>
74    <TR>
75<td valign="top" width="120" bgcolor="#ffffe8"><em><strong>ggid</strong></em></td>
76<TD width="520">Game Group ID (GGID) provided by Nintendo for each title with MP communications capability.</TD>
77    </TR>
78    <TR>
79<td valign="top" width="120" bgcolor="#ffffe8"><em><strong>tgid</strong></em></td>
80<TD width="520">16-bit ID that must be generated each time a parent is started.<br>An appropriate value is automatically assigned using <CODE>MP_TGID_AUTO</CODE>. </TD>
81    </TR>
82    <TR>
83<td valign="top" width="120" bgcolor="#ffffe8"><em><strong>channel</strong></em></td>
84<TD width="520">The wireless channel to use.<br> <CODE>MP_CHANNEL_AUTO</CODE> is normally specified so the appropriate channel is selected automatically.</TD>
85    </TR>
86
87
88
89<TR><td colspan="2">Members specific to the MPDL library</td></TR>
90    <TR>
91<td valign="top" width="120" bgcolor="#ffffe8"><em><strong>serverColor</strong></em></td>
92<TD width="520">Any color number from 0 to 15 of your choosing to be used when displaying the DS download play program on the Nintendo DS system.</TD>
93    </TR>
94    <TR>
95<td valign="top" width="120" bgcolor="#ffffe8"><em><strong>serverName</strong></em></td>
96<TD width="520">The name for the server operator that will be displayed by the DS Download Play program on the Nintendo DS.<br>The name must be specified as a Unicode (UTF16-LE) character string of no more than 10 characters (excluding the termination character).<br><B>Note:</B> This can be denoted in CodeWarrior with <i>L&quot;(string)&quot;</i>.</TD>
97    </TR>
98    <TR>
99<td valign="top" width="120" bgcolor="#ffffe8"><em><strong>programTitle</strong></em></td>
100<TD width="520">The name for the program title that will be displayed by the DS Download Play program on the Nintendo DS.<br>The name must be specified as a Unicode (UTF16-LE) character string of no more than 48 characters (excluding the termination character). <br><B>Note:</B> This can be denoted in CodeWarrior with <i>L&quot;(string)&quot;</i>.</TD>
101    </TR>
102    <TR>
103<td valign="top" width="120" bgcolor="#ffffe8"><em><strong>programComment</strong></em></td>
104<TD width="520">The description of the program that will be displayed by the DS Download Play program on the Nintendo DS.<br>The text must be specified as a Unicode (UTF16-LE) character string of no more than 96 characters (excluding the termination character). <br><B>Note:</B> This can be denoted in CodeWarrior with <i>L&quot;(string)&quot;</i>.</TD>
105    </TR>
106    <TR>
107<td valign="top" width="120" bgcolor="#ffffe8"><em><strong>programMaxEntry</strong></em></td>
108<TD width="520">Maximum number of persons a session will allow for simultaneous connection. Can take any value between 2 and 16.<br />Note that the parent device itself is included in the count.</TD>
109    </TR>
110    <TR>
111<td valign="top" width="120" bgcolor="#ffffe8"><em><strong>programImage</strong></em></td>
112<TD width="520">Pointer to the memory where the Nintendo DS program to be distributed is loaded.</TD>
113    </TR>
114    <TR>
115<td valign="top" width="120" bgcolor="#ffffe8"><em><strong>bannerCharacter<br />bannerPalette</strong></em></td>
116<TD width="520">The character data and palette data for the icon image that will be used for display by the DS Download Play program on the Nintendo DS.<br />This icon image consists of 16 colors of palette data and 32 x 32 dots of image data.<br />If the data are omitted by specifying NULL, the banner image recorded in the Nintendo DS program itself is utilized for display. <br /></TD>
117    </TR>
118
119
120    <TR>
121<td valign="top" width="120" bgcolor="#ffffe8"><em><strong>internalWork1</strong></em></td>
122<TD rowspan="6"><font color="gray">(Used internally by the library.)</font></TD>
123    </TR>
124    <TR>
125<td valign="top" width="120" bgcolor="#ffffe8"><em><strong>internalWork2</strong></em></td>
126      <TD></TD>
127    </TR>
128    <TR>
129<td valign="top" width="120" bgcolor="#ffffe8"><em><strong>entry_flag</strong></em></td>
130      <TD></TD>
131    </TR>
132    <TR>
133<td valign="top" width="120" bgcolor="#ffffe8"><em><strong>mb_flag</strong></em></td>
134      <TD></TD>
135    </TR>
136    <TR>
137<td valign="top" width="120" bgcolor="#ffffe8"><em><strong>bitmap</strong></em></td>
138      <TD></TD>
139    </TR>
140    <TR>
141<td valign="top" width="120" bgcolor="#ffffe8"><em><strong>mpConfig</strong></em></td>
142      <TD></TD>
143    </TR>
144
145  </TBODY>
146</TABLE>
147
148<h2>See Also</h2>
149<p>
150<code><a href="./MPDLStartup.html">MPDLStartup()</a></code>, <code><a href="./MPDLCleanup.html">MPDLCleanup()</a></code>
151</p>
152
153<H2>Revision History</H2>
154<p>
1552007/10/11 Added member relating to banner image.<br />2007/05/07 Changed the maximum value of settings.<br />2007/05/02 Added a description of <CODE>MP_CHANNEL_AUTO</CODE> to <CODE>channel</CODE>.<br>2006/08/15 Added a note to indicate that the parent device is included in <CODE>programMaxEntry</CODE>.<br />2006/07/13 Added members to structure definition.<br />2006/07/04 Initial version. <br />
156</p>
157
158<hr><p>CONFIDENTIAL</p></body>
159</html>
160