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<META name="GENERATOR" content="IBM WebSphere Studio Homepage Builder Version 8.0.0.0 for Windows"> 7<BASE target="main"> 8<TITLE>List of Single-Card Play (MB) functions</TITLE> 9<LINK rel="stylesheet" href="../css/apilist.css"> 10</HEAD> 11<BODY> 12<H1>List of Single-Card Play (MB) functions</H1> 13<H3><A name="Init">Initialization</A></H3> 14<TABLE border="1" width="100%"> 15 <TBODY> 16 <TR> 17 <TH width="25%"><A href="common/MB_Init.html" target="_self">MB_Init</A></TH> 18 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 19 <TD>Initializes the library.</TD> 20 </TR> 21 <TR> 22 <TH width="25%"><A href="common/MB_End.html" target="_self">MB_End</A></TH> 23 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 24 <TD>Closes the library. The wireless library reverts to the state before initialization.</TD> 25 </TR> 26 <TR> 27 <TH width="25%"><A href="common/MB_EndToIdle.html" target="_self">MB_EndToIdle</A></TH> 28 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 29 <TD>Closes the library. The wireless library changes to the <CODE>IDLE</CODE> state.</TD> 30 </TR> 31 <TR> 32 <TH width="25%"><A href="common/MB_GetParentSystemBufSize.html" target="_self">MB_GetParentSystemBufSize</A></TH> 33 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 34 <TD>Obtains the size of the work memory used by MB.</TD> 35 </TR> 36 <TR> 37 <TH width="25%"><A href="common/MB_GetTgid.html" target="_self">MB_GetTgid</A></TH> 38 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 39 <TD>Obtains the TGID value specified at the time of initialization.</TD> 40 </TR> 41 </TBODY> 42</TABLE> 43<H3><A name="Child">Child (after multiboot)</A></H3> 44<TABLE border="1" width="100%"> 45 <TBODY> 46 <TR> 47 <TH width="25%"><A href="common/MB_IsMultiBootChild.html" target="_self">MB_IsMultiBootChild</A></TH> 48 <TD width="48"><img src="../image/NTR.gif"><img src="../image/BPT.gif"></TD> 49 <TD>Determines whether the application itself is a multiboot child.</TD> 50 </TR> 51 <TR> 52 <TH width="25%"><A href="common/MB_GetMultiBootParentBssDesc.html" target="_self">MB_GetMultiBootParentBssDesc</A></TH> 53 <TD><img src="../image/NTR.gif"><img src="../image/BPT.gif"></TD> 54 <TD>Obtains multiboot parent information.</TD> 55 </TR> 56 <TR> 57 <TH width="25%"><A href="child/MB_GetMultiBootDownloadParameter.html" target="_self">MB_GetMultiBootDownloadParameter</A></TH> 58 <TD><img src="../image/NTR.gif"><img src="../image/BPT.gif"></TD> 59 <TD>Obtains the user-defined extended parameters during download.</TD> 60 </TR> 61 <TR> 62 <TH width="25%"><A href="child/MB_ReadMultiBootParentBssDesc.html" target="_self">MB_ReadMultiBootParentBssDesc</A></TH> 63 <TD><img src="../image/NTR.gif"><img src="../image/BPT.gif"></TD> 64 <TD>Obtains the information for the <CODE>WM_StartConnect</CODE> function based on the multiboot parent information.</TD> 65 </TR> 66 <TR> 67 <TH><A href="common/MB_GetUserVolatData.html">MB_GetUserVolatData</A></TH> 68 <TD><img src="../image/NTR.gif"><img src="../image/BPT.gif"></TD> 69 <TD>Extracts the user data in <code>MBGameInfoVolatile</code> from the MB parent beacon.</TD> 70 </TR> 71 </TBODY> 72</TABLE> 73<H3><A name="Parent">Parent</A></H3> 74<TABLE border="1" width="100%"> 75 <TBODY> 76 <TR> 77 <TH width="25%"><A href="parent/MB_SetParentCommSize.html" target="_self">MB_SetParentCommSize</A></TH> 78 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 79 <TD>Sets the communication data size of the parent.</TD> 80 </TR> 81 <TR> 82 <TH width="25%"><A href="parent/MB_SetParentCommParam.html" target="_self">MB_SetParentCommParam</A></TH> 83 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 84 <TD>Sets the communication data size of the parent and the maximum number of children to be connected.</TD> 85 </TR> 86 <TR> 87 <TH width="25%"><A href="parent/MB_SetPowerSaveMode.html" target="_self">MB_SetPowerSaveMode</A></TH> 88 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 89 <TD>Sets the parent's wireless energy-saving mode.</TD> 90 </TR> 91 <TR> 92 <TH width="25%"><A href="parent/MB_SetLifeTime.html" target="_self">MB_SetLifeTime</A></TH> 93 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 94 <TD>Sets lifetimes for the parent's wireless communication.</TD> 95 </TR> 96 <TR> 97 <TH width="25%"><A href="parent/MB_StartParent.html" target="_self">MB_StartParent</A></TH> 98 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 99 <TD>Starts processing as a multiboot parent.</TD> 100 </TR> 101 <TR> 102 <TH width="25%"><A href="parent/MB_StartParentFromIdle.html" target="_self">MB_StartParentFromIdle</A></TH> 103 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 104 <TD>Starts processing as a multiboot parent with the wireless library in the <CODE>IDLE</CODE> state.</TD> 105 </TR> 106 <TR> 107 <TH width="25%"><A href="parent/MB_CommGetChildrenNumber.html" target="_self">MB_CommGetChildrenNumber</A></TH> 108 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 109 <TD>Obtains the total number of connected children.</TD> 110 </TR> 111 <TR> 112 <TH width="25%"><A href="parent/MB_CommGetChildUser.html" target="_self">MB_CommGetChildUser</A></TH> 113 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 114 <TD>Obtains the connection information for the specified child.</TD> 115 </TR> 116 117 <TR> 118 <TH width="25%"><A href="parent/MB_CommGetParentState.html" target="_self">MB_CommGetParentState</A></TH> 119 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 120 <TD>Obtains the state of the current parent.</TD> 121 </TR> 122 <TR> 123 <TH width="25%"><A href="parent/MB_CommSetParentStateCallback.html" target="_self">MB_CommSetParentStateCallback</A></TH> 124 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 125 <TD>Sets the callback function, which notifies you of changes to the parent state.</TD> 126 </TR> 127 <TR> 128 <TH width="25%"><A href="parent/MB_GetSegmentLength.html" target="_self">MB_GetSegmentLength</A></TH> 129 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 130 <TD>Gets the segment length for the specified program.</TD> 131 </TR> 132 <TR> 133 <TH width="25%"><A href="parent/MB_ReadSegment.html" target="_self">MB_ReadSegment</A></TH> 134 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 135 <TD>Gets the segment information from the specified program.</TD> 136 </TR> 137 <TR> 138 <TH width="25%"><A href="parent/MB_RegisterFile.html" target="_self">MB_RegisterFile</A></TH> 139 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 140 <TD>Registers the specified program in the download process.</TD> 141 </TR> 142 <TR> 143 <TH width="25%"><A href="parent/MB_UnregisterFile.html" target="_self">MB_UnregisterFile</A></TH> 144 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 145 <TD>Specifies a registered application and releases it from the download list.</TD> 146 </TR> 147 <TR> 148 <TH width="25%"><A href="parent/MB_CommResponseRequest.html" target="_self">MB_CommResponseRequest</A></TH> 149 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 150 <TD>Sends a response to the child that requested the connection.</TD> 151 </TR> 152 <TR> 153 <TH width="25%"><A href="parent/MB_CommStartSending.html" target="_self">MB_CommStartSending</A></TH> 154 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 155 <TD>Sends a download start notice to the child that has been granted the connection request.</TD> 156 </TR> 157 <TR> 158 <TH width="25%"><A href="parent/MB_CommStartSendingAll.html" target="_self">MB_CommStartSendingAll</A></TH> 159 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 160 <TD>Sends the download start notification to all children that have been granted the connection request.</TD> 161 </TR> 162 <TR> 163 <TH width="25%"><A href="parent/MB_CommIsBootable.html" target="_self">MB_CommIsBootable</A></TH> 164 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 165 <TD>Determines whether the specific child is bootable.</TD> 166 </TR> 167 <TR> 168 <TH width="25%"><A href="parent/MB_CommBootRequest.html" target="_self">MB_CommBootRequest</A></TH> 169 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 170 <TD>Sends the boot request to a specific bootable child.</TD> 171 </TR> 172 <TR> 173 <TH width="25%"><A href="parent/MB_CommBootRequestAll.html" target="_self">MB_CommBootRequestAll</A></TH> 174 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 175 <TD>Sends the boot request to all bootable children.</TD> 176 </TR> 177 <TR> 178 <TH><A href="parent/MB_DisconnectChild.html" target="_self">MB_DisconnectChild</A></TH> 179 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 180 <TD>Forcibly disconnects a child device.</TD> 181 </TR> 182 <TR> 183 <TH width="25%"><A href="parent/MB_GetGameEntryBitmap.html" target="_self">MB_GetGameEntryBitmap</A></TH> 184 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 185 <TD>Obtains all AID bitmaps that are entered for the specified game information.</TD> 186 </TR> 187 <TR> 188 <TH><A href="common/MB_SetSendVolatCallback.html">MB_SetSendVolatCallback</A></TH> 189 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 190 <TD>Sets the callback used when sending <code>MBGameInfoVolatile</code> as a beacon.</TD> 191 </TR> 192 <TR> 193 <TH><A href="common/MB_SetUserVolatData.html">MB_SetUserVolatData</A></TH> 194 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 195 <TD>Sets the user info in <code>MBGameInfoVolatile</code>.</TD> 196 </TR> 197 </TBODY> 198</TABLE> 199<H3><A name="FakeChild">Fake Multiboot Child</A></H3> 200<TABLE border="1"> 201 <TBODY> 202 <TR> 203 <TH><A href="fake_child/MB_FakeInit.html">MB_FakeInit</A></TH> 204 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 205 <TD>Initializes a fake multiboot child.</TD> 206 </TR> 207 <TR> 208 <TH><A href="fake_child/MB_FakeEnd.html">MB_FakeEnd</A></TH> 209 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 210 <TD>Ends a fake multiboot child process. Use this function to terminate the process when download is successful or when canceling.</TD> 211 </TR> 212 <TR> 213 <TH><A href="fake_child/MB_FakeGetWorkSize.html">MB_FakeGetWorkSize</A></TH> 214 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 215 <TD>Obtains the buffer size required for a fake multiboot child.</TD> 216 </TR> 217 <TR> 218 <TH><A href="fake_child/MB_FakeStartScanParent.html">MB_FakeStartScanParent</A></TH> 219 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 220 <TD>Starts scanning for a multiboot parent.</TD> 221 </TR> 222 <TR> 223 <TH><A href="fake_child/MB_FakeEndScan.html">MB_FakeEndScan</A></TH> 224 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 225 <TD>Ends scanning for a multiboot parent.</TD> 226 </TR> 227 <TR> 228 <TH><A href="fake_child/MB_FakeSetCStateCallback.html">MB_FakeSetCStateCallback</A></TH> 229 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 230 <TD>Sets a callback function that broadcasts the entry state to a multiboot parent.</TD> 231 </TR> 232 <TR> 233 <TH><A href="fake_child/MB_FakeEntryToParent.html">MB_FakeEntryToParent</A></TH> 234 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 235 <TD>Makes an entry to a multiboot parent.</TD> 236 </TR> 237 <TR> 238 <TH><A href="fake_child/MB_FakeGetParentGameInfo.html">MB_FakeGetParentGameInfo</A></TH> 239 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 240 <TD>Obtains a scanned multiboot parent's game information.</TD> 241 </TR> 242 <TR> 243 <TH><A href="fake_child/MB_FakeGetParentBssDesc.html">MB_FakeGetParentBssDesc</A></TH> 244 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 245 <TD>Obtains a scanned multiboot parent's connection information.</TD> 246 </TR> 247 <TR> 248 <TH><A href="fake_child/MB_FakeReadParentBssDesc.html">MB_FakeReadParentBssDesc</A></TH> 249 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 250 <TD>Obtains a scanned multiboot parent's connection information, including flag or packet size settings.</TD> 251 </TR> 252 <TR> 253 <TH><A href="fake_child/MB_FakeSetVerboseScanCallback.html">MB_FakeSetVerboseScanCallback</A></TH> 254 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 255 <TD>Sets a callback for acquiring the live beacons received while scanning for a multiboot parent.</TD> 256 </TR> 257 <TR> 258 <TH><A href="fake_child/MB_FakeSetCompareGGIDCallback.html">MB_FakeSetCompareGGIDCallback</A></TH> 259 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 260 <TD>Sets a callback for filtering when scanning for a multiboot parent.</TD> 261 </TR> 262 263 </TBODY> 264</TABLE> 265<H3><A name="const">Constants and Structures</A></H3> 266<TABLE border="1" width="100%"> 267 <TBODY> 268 <TR> 269 <TH width="25%"><A href="mb_comm_parent_consts.html" target="_self">MB_COMM_PARENT_*</A></TH> 270 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 271 <TD>Constant that shows the range of sizes that can be set for the communication by a multiboot parent.</TD> 272 </TR> 273 <TR> 274 <TH width="25%"><A href="mb_segment_buffer_min_const.html" target="_self">MB_SEGMENT_BUFFER_MIN</A></TH> 275 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 276 <TD>Constant that indicates the minimum buffer size required for the <CODE><A href="parent/MB_ReadSegment.html" target="_self">MB_ReadSegment</A></CODE> function.</TD> 277 </TR> 278 <TR> 279 <TH width="25%"><A href="mb_game_consts.html" target="_self">MB_ICON_*</A></TH> 280 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 281 <TD>Constants that define the format of multiboot icons.</TD> 282 </TR> 283 <TR> 284 <TH width="25%"><A href="mb_game_consts.html" target="_self">MB_GAME_*</A></TH> 285 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 286 <TD>Constants that define the format of multiboot game information.</TD> 287 </TR> 288 <TR> 289 <TH width="25%"><A href="mb_game_consts.html" target="_self">MB_USER_*</A></TH> 290 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 291 <TD>Constants that define the format of multiboot user information.</TD> 292 </TR> 293 <TR> 294 <TH width="25%"><A href="mb_tgid_auto_const.html" target="_self">MB_TGID_AUTO</A></TH> 295 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 296 <TD>Constant that specifies automatic generation of TGID.</TD> 297 </TR> 298 <TR> 299 <TH width="25%"><A href="mb_fake_work_size_const.html" target="_self">MB_FAKE_WORK_SIZE</A></TH> 300 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 301 <TD>Constant that expresses the work buffer size needed by the fake multiboot child.</TD> 302 </TR> 303 <TR> 304 <TH width="25%"><A href="mb_error_status_type.html" target="_self">MBErrorStatus</A></TH> 305 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 306 <TD>Structure that is passed as an argument of the <CODE><A href="mb_comm_pstate_const.html" target="_self">MB_COMM_PSTATE_ERROR</A></CODE> callback.</TD> 307 </TR> 308 <TR> 309 <TH width="25%"><A href="mb_err_code_const.html" target="_self">MBErrCode</A></TH> 310 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 311 <TD>Enumerator type that defines the error codes of the MB library.</TD> 312 </TR> 313 <TR> 314 <TH width="25%"><A href="mb_comm_pstate_const.html" target="_self">MBCommPState</A></TH> 315 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 316 <TD>Enumerator that shows the parent state.</TD> 317 </TR> 318 <TR> 319 <TH><A href="mb_comm_cstate_const.html" target="_self">MBCommCState</A></TH> 320 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 321 <TD>Enumerated value that indicates the child state when using a fake child.</TD> 322 </TR> 323 <TR> 324 <TH width="25%"><A href="mb_comm_response_request_type_const.html" target="_self">MBCommResponseRequestType</A></TH> 325 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 326 <TD>Enumerated value for indicating the type of response to the child connection request.</TD> 327 </TR> 328 <TR> 329 <TH width="25%"><A href="mb_comm_pstate_callback_type.html" target="_self">MBCommPStateCallback</A></TH> 330 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 331 <TD>The format of the callback function, which notifies you of changes to the parent state.</TD> 332 </TR> 333 <TR> 334 <TH><A href="mb_comm_cstate_callback_type.html" target="_self">MBCommCStateCallbackFunc</A></TH> 335 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 336 <TD>Callback function format that indicates update of a fake child state.</TD> 337 </TR> 338 <TR> 339 <TH width="25%"><A href="mb_game_registry_type.html" target="_self">MBGameRegistry</A></TH> 340 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 341 <TD>Structure showing game information registered in the download process.</TD> 342 </TR> 343 <TR> 344 <TH width="25%"><A href="mb_icon_info_type.html" target="_self">MBIconInfo</A></TH> 345 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 346 <TD>Structure showing the format of user icons.</TD> 347 </TR> 348 <TR> 349 <TH width="25%"><A href="mb_user_info_type.html" target="_self">MBUserInfo</A></TH> 350 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 351 <TD>Structure showing user information.</TD> 352 </TR> 353 <TR> 354 <TH width="25%"><A href="mb_parent_bss_desc_type.html" target="_self">MBParentBssDesc</A></TH> 355 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 356 <TD>Structure showing connection information for the multiboot parent.</TD> 357 </TR> 358 <TR> 359 <TH><A href="common/MBGameInfo.html">MBGameInfo</A></TH> 360 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 361 <TD>Structure showing multiboot parent game information.</TD> 362 </TR> 363 <TR> 364 <TH><A href="fake_child/MBFakeScanCallback.html">MBFakeScanCallback</A></TH> 365 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 366 <TD>Structure showing parent information that can be obtained with a parent scan callback.</TD> 367 </TR> 368 <TR> 369 <TH><A href="fake_child/MBFakeScanCallbackFunc.html">MBFakeScanCallbackFunc</A></TH> 370 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 371 <TD>Callback function that notifies of the parent scan callback.</TD> 372 </TR> 373 <TR> 374 <TH><A href="fake_child/MBFakeCompareGGIDCallbackFunc.html">MBFakeCompareGGIDCallbackFunc</A></TH> 375 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 376 <TD>The callback function for filtering the parent scan.</TD> 377 </TR> 378 <TR> 379 <TH><A href="fake_child/MBFakeScanErrorCallback.html">MBFakeScanErrorCallback</A></TH> 380 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 381 <TD>Error information structure passed as a callback argument if an error occurs during a parent scan.</TD> 382 </TR> 383 </TBODY> 384</TABLE> 385 386<table border="0" height="100%"><tr><td style="background-color : white;"></td></tr></table> 387 388<hr><p>CONFIDENTIAL</p></body> 389</HTML>