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>Definition</h2> 16<dl><dd> 17<pre><code> 18#include <revolution/mpdl.h> 19 20#define MPDL_DOWNLOAD_PARAMETER_SIZE 32 21 22typedef struct MPDLConfig 23{ 24 void* (*alloc)(u32 size); 25 void (*free) (void* ptr); 26 OSPriority threadPriority; 27 u32 ggid; 28 u32 tgid; 29 u32 channel; 30 31 u8 serverColor; 32 const u16 *serverName; 33 const u16 *programTitle; 34 const u16 *programComment; 35 u32 programMaxEntry; 36 const u8 *programImage; 37 const void *bannerCharacter; 38 const void *bannerPalette; 39 u8 userParam[MPDL_DOWNLOAD_PARAMETER_SIZE]; 40 41 void *internalWork1; 42 void *internalWork2; 43 BOOL entry_flag; 44 BOOL mb_flag; 45 u32 bitmap; 46 MPConfig mpConfig[1]; 47} 48MPDLConfig; 49</code></pre> 50</dd></dl> 51 52<H2>Description</H2> 53<p> 54The MPDLConfig structure is used to store MPDL library settings and configuration information for the MP library that is automatically controlled internally. 55</p> 56<TABLE border="1"> 57 <TBODY> 58 <tr> 59<th><strong>Member</strong></th> 60<th><strong>Description</strong></th> 61 </tr> 62 <tr> 63<td colspan="2">Members used "as is" for the MP library's <a href="../mp/MPConfig.html">MPConfig</a></td> 64 </tr> 65 <TR> 66<td valign="top" width="120" bgcolor="#ffffe8"><em><strong>alloc</strong></em></td> 67<TD width="520">Function to allocate memory for use inside the project.</TD> 68 </TR> 69 <TR> 70<td valign="top" width="120" bgcolor="#ffffe8"><em><strong>free</strong></em></td> 71<TD width="520">Function to deallocate memory used inside the project.</TD> 72 </TR> 73 <TR> 74<td valign="top" width="120" bgcolor="#ffffe8"><em><strong>threadPriority</strong></em></td> 75<TD width="520">Priority level of MP working thread.<br>Several working threads are created having this priority level or lower. </TD> 76 </TR> 77 <TR> 78<td valign="top" width="120" bgcolor="#ffffe8"><em><strong>ggid</strong></em></td> 79<TD width="520">Game Group ID (GGID) provided by Nintendo for each title with MP communications capability.</TD> 80 </TR> 81 <TR> 82<td valign="top" width="120" bgcolor="#ffffe8"><em><strong>tgid</strong></em></td> 83<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> 84 </TR> 85 <TR> 86<td valign="top" width="120" bgcolor="#ffffe8"><em><strong>channel</strong></em></td> 87<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> 88 </TR> 89 90 91 92<TR><td colspan="2">Members specific to the MPDL library</td></TR> 93 <TR> 94<td valign="top" width="120" bgcolor="#ffffe8"><em><strong>serverColor</strong></em></td> 95<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> 96 </TR> 97 <TR> 98<td valign="top" width="120" bgcolor="#ffffe8"><em><strong>serverName</strong></em></td> 99<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"(string)"</i>.</TD> 100 </TR> 101 <TR> 102<td valign="top" width="120" bgcolor="#ffffe8"><em><strong>programTitle</strong></em></td> 103<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"(string)"</i>.</TD> 104 </TR> 105 <TR> 106<td valign="top" width="120" bgcolor="#ffffe8"><em><strong>programComment</strong></em></td> 107<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"(string)"</i>.</TD> 108 </TR> 109 <TR> 110<td valign="top" width="120" bgcolor="#ffffe8"><em><strong>programMaxEntry</strong></em></td> 111<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> 112 </TR> 113 <TR> 114<td valign="top" width="120" bgcolor="#ffffe8"><em><strong>programImage</strong></em></td> 115<TD width="520">Pointer to the memory where the Nintendo DS program to be distributed is loaded.</TD> 116 </TR> 117 <TR> 118<td valign="top" width="120" bgcolor="#ffffe8"><em><strong>bannerCharacter<br />bannerPalette</strong></em></td> 119<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> 120 </TR> 121 <TR> 122<td valign="top" width="120" bgcolor="#ffffe8"><em><strong>userParam</strong></em></td> 123<TD width="520">User-defined extended parameter that can be provided to the child device program that started this distributed program.<br /> Up to <CODE>MPDL_DOWNLOAD_PARAMETER_SIZE</CODE> (=32) bytes of data can be set freely and referenced by the child device program that started this program.<br /></TD> 124 </TR> 125 126 127 <TR> 128<td valign="top" width="120" bgcolor="#ffffe8"><em><strong>internalWork1</strong></em></td> 129<TD rowspan="6"><font color="gray">(Used internally by the library.)</font></TD> 130 </TR> 131 <TR> 132 <td valign="top" width="120" bgcolor="#ffffe8"><em><strong>internalWork2</strong></em></td> 133 <TD></TD> 134 </TR> 135 <TR> 136 <td valign="top" width="120" bgcolor="#ffffe8"><em><strong>entry_flag</strong></em></td> 137 <TD></TD> 138 </TR> 139 <TR> 140 <td valign="top" width="120" bgcolor="#ffffe8"><em><strong>mb_flag</strong></em></td> 141 <TD></TD> 142 </TR> 143 <TR> 144 <td valign="top" width="120" bgcolor="#ffffe8"><em><strong>bitmap</strong></em></td> 145 <TD></TD> 146 </TR> 147 <TR> 148 <td valign="top" width="120" bgcolor="#ffffe8"><em><strong>mpConfig</strong></em></td> 149 <TD></TD> 150 </TR> 151 152 </TBODY> 153</TABLE> 154 155<h2>See Also</h2> 156<p> 157<code><a href="./MPDLStartup.html">MPDLStartup()</a></code>, 158<code><a href="./MPDLCleanup.html">MPDLCleanup()</a></code> 159</p> 160 161<H2>Revision History</H2> 162<p> 1632008/02/01 Added the <em><strong>userParam</strong></em> member.<br />2007/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 /> 164</p> 165 166<hr><p>CONFIDENTIAL</p></body> 167</html> 168