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 name="GENERATOR" content="IBM WebSphere Studio Homepage Builder Version 8.0.0.0 for Windows"> 6<META http-equiv="Content-Style-Type" content="text/css"> 7<title>WMGameInfo</title> 8<LINK rel="stylesheet" href="../../css/nitro.css" type="text/css"> 9</head> 10<body> 11<h1 align="left">WMGameInfo</h1> 12<h2>Definition</h2> 13<dl> 14 <dd> 15<CODE>#include <nitro/wm.h></CODE><BR> 16 <PRE><CODE> 17typedef struct WMGameInfo 18{ 19 u16 magicNumber; 20 u8 ver; 21 u8 reserved[1]; 22 u32 ggid; 23 u16 tgid; 24 u8 userGameInfoLength; 25 u8 attribute; 26 u16 parentMaxSize; 27 u16 childMaxSize; 28 union { 29 u16 userGameInfo[WM_SIZE_USER_GAMEINFO/sizeof(u16)]; 30 struct { 31 u16 userName[WM_SIZE_USERNAME/sizeof(u16)]; 32 u16 gameName[WM_SIZE_GAMENAME/sizeof(u16)]; 33 u16 padd1[44]; 34 } old_type; 35 }; 36} WMGameInfo; 37</CODE></PRE> 38 </dd> 39</dl><h2>Elements</h2> 40<TABLE border="1" width="100%"> 41 <TBODY> 42 <TR> 43<TD width="200"><code>magicNumber</code></TD> 44<TD width="800">Magic number of this structure.<br>Fixed at <code>WM_GAMEINFO_MAGIC_NUMBER</code> (<code>0x0001</code>).</TD> 45 </TR> 46 <TR> 47<TD width="200"><code>ver</code></TD> 48<TD width="800">Version number of this structure.<br>It is managed in the library, and the user does not need to be concerned with it.</TD> 49 </TR> 50 <TR> 51<TD width="200"><code>ggid</code></TD> 52<TD width="800">Game group ID. This is a unique value for identifying game applications with compatible communication.</TD> 53 </TR> 54 <TR> 55<TD width="200"><code>tgid</code></TD> 56<TD width="800">Temporary group ID. This is a dynamic value set on the parent side to allow uniqueness when the same device and same game application establish multiple communication.</TD> 57 </TR> 58 <TR> 59<TD width="200"><code>userGameInfoLength</code></TD> 60<TD width="800">Size, in bytes, of available data stored in <code>userGameInfo</code>. Maximum is 112 bytes.</TD> 61 </TR> 62 <TR> 63<TD width="200"><code>userGameInfo</code></TD> 64<TD width="800">Array in which any information characteristic to the application is stored.</TD> 65 </TR> 66 <TR> 67<TD width="200"><code>attribute</code></TD> 68<TD width="800">The value showing parent attributes, such as "download play possible while receiving entry."</TD> 69 </TR> 70 <TR> 71<TD width="200"><code>parentMaxSize</code></TD> 72<TD width="800">Maximum size of parent's send data in MP communication.</TD> 73 </TR> 74 <TR> 75<TD width="200"><code>childMaxSize</code></TD> 76<TD width="800">Maximum size of child's send data in MP communication.</TD> 77 </TR> 78 <TR> 79<TD width="200"><font color="#808080"><code>reserved</code></font></TD> 80<TD width="800" rowspan="1"><font color="#808080">Reserved region.<br> The user does not need to use this argument.</font></TD> 81 </TR> 82 <TR> 83<TD width="200"><font color="#808080"><code>old_type</code></font></TD> 84<TD width="800" rowspan="1"><font color="#808080">Provided for compatibility with old format.<br> The user does not need to use this argument.</font></TD> 85 </TR> 86 </TBODY> 87</TABLE> 88<H2>Description</H2> 89<P> 90This structure stores information for the parent device that is discovered as the result of searching with the <a href="WM_StartScan.html"><code>WM_StartScan</code></a> function.<br> 91</P> 92<P>The <code>attribute</code> field consists of the following logical sums.</P> 93<TABLE border="1" width="100%"> 94 <TBODY> 95 <TR> 96<TD width="300"> <code>WM_ATTR_FLAG_ENTRY</code></TD> 97<TD width="700">"Receiving entry" flag.</TD> 98 </TR> 99 <TR> 100<TD width="300"> <code>WM_ATTR_FLAG_MB</code></TD> 101<TD width="700">"Download play possible" flag.</TD> 102 </TR> 103 <TR> 104<TD width="300"><DEL> <code>WM_ATTR_FLAG_KS</code></DEL></TD> 105<TD width="700"><DEL>"Key sharing" flag</DEL>Not currently used.</TD> 106 </TR> 107 <TR> 108<TD width="300"><DEL> <code>WM_ATTR_FLAG_CS</code></DEL></TD> 109<TD width="700"><DEL>Continuation communication mode.</DEL>Not currently used.</TD> 110 </TR> 111 </TBODY> 112</TABLE> 113<P>Before any fields of the <code>WMGameInfo</code> structure can be accessed, it is necessary to check that the <code>magicNumber</code> field equals <code>WM-GAMEINFO_MAGIC_NUMBER</code> (<code>0x0001</code>). Use the <A href="WM_IsValidGameInfo.html"><code>WM_IsValidGameInfo</code></A> or <A href="WM_IsValidGameBeacon.html"><code>WM_IsValidGameBeacon</code></A> function to check the <code>magicNumber</code> field. Because the <code>WMGameInfo</code> structure is extended for backward compatibility as long as <code>magicNumber</code> is equal, if the <code>ver</code> field contains an unknown value, be sure to assume this version has the same functions as the current one.</P> 114<H2>Revision History</H2> 115<P> 1162006/02/20 Deleted <code>version</code> and added <code>magicNumber</code> and <code>ver</code>. Added descriptions.<BR>2005/12/08 Deleted a description related to key sharing.<BR> 2005/03/02 Added statement regarding the range for the <code>userGameInfoLength</code> member.<br /> 2004/12/20 Added explanation of <code>gameNameCount_attribute</code>.<BR> 2004/11/12 Corrected the unit of <code>userGameInfoLength</code>.<br> 2004/10/06 Initial version. 117</P> 118<hr><p>CONFIDENTIAL</p></body> 119</html> 120