1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 2<html xml:lang="en-US" lang="en-US" xmlns="http://www.w3.org/1999/xhtml"> 3 <head> 4 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 5 <meta http-equiv="Content-Style-Type" content="text/css" /> 6 <link rel="stylesheet" href="../../../../css/manpage.css" type="text/css" /> 7 <style type="text/css"><!-- 8 span.static_style 9 { 10 font-size : 8pt; 11 color : white; 12 font-weight : bold; 13 background : #44f; 14 border-left : solid 1px #aaf; 15 border-top : solid 1px #aaf; 16 border-right : solid 1px #00c; 17 border-bottom : solid 1px #00c; 18 padding-left : 2px; 19 padding-right : 2px; 20 } 21 22 span.virtual_style 23 { 24 font-size : 8pt; 25 color : white; 26 font-weight : bold; 27 background : #0a0; 28 border-left : solid 1px #0f0; 29 border-top : solid 1px #0f0; 30 border-right : solid 1px #060; 31 border-bottom : solid 1px #060; 32 padding-left : 2px; 33 padding-right : 2px; 34 } 35 36 span.protected_style 37 { 38 font-size : 8pt; 39 color : white; 40 font-weight : bold; 41 background : #444; 42 border-left : solid 1px #ccc; 43 border-top : solid 1px #ccc; 44 border-right : solid 1px #222; 45 border-bottom : solid 1px #222; 46 padding-left : 2px; 47 padding-right : 2px; 48 } 49 --></style> 50<title>nn::cec::CTR::MessageBox</title> 51 </head> 52 <body> 53<h1><CODE>nn::cec::CTR::MessageBox</CODE> Class</h1> 54<h2>Syntax</h2> 55 <div class="section"> 56 <pre class="definition">class MessageBox</pre> 57 </div> 58<h2>Description</h2> 59 <div class="section"> 60<p>Class for accessing CEC <CODE>MessageBox</CODE> objects.</p><!-- write here --></div> 61 <a name="function" id="function"> 62<h2>Member Functions</h2> 63 <div class="section"> 64 <table class="members"> 65 <tr> 66<th class="category" colspan="3">Create/Delete a Message Box</th> 67 </tr> 68 <tr> 69 <td width="100"> </td> 70 <th> 71<a href="../../../../nn/cec/CTR/MessageBox/CreateMessageBox.html"><CODE>CreateMessageBox</CODE></a> 72 </th> 73<td>Creates a <CODE>MessageBox</CODE>. An inbox and outbox are created within the message box. Any <a href="../../../../nn/cec/CTR/Message/Overview.html">message</a> set in the outbox is automatically sent during StreetPass communication, and any received data is stored in the inbox.</td> 74 </tr> 75 <tr> 76 <td width="100"> </td> 77 <th> 78<a href="../../../../nn/cec/CTR/MessageBox/DeleteMessageBox.html"><CODE>DeleteMessageBox</CODE></a> 79 </th> 80<td>Deletes a <CODE><a href="../../../../nn/cec/CTR/MessageBox/Overview.html">MessageBox</a></CODE>.</td> 81 </tr> 82 <tr> 83 <td width="100"> </td> 84 <th> 85<a href="../../../../nn/cec/CTR/MessageBox/OpenMessageBox.html"><CODE>OpenMessageBox</CODE></a> 86 </th> 87<td>Opens a <CODE><a href="../../../../nn/cec/CTR/MessageBox/Overview.html">MessageBox</a></CODE>. You must use this function to open a box before you can access the messages within it.</td> 88 </tr> 89 <tr> 90<th class="category" colspan="3">Message Operations</th> 91 </tr> 92 <tr> 93 <td width="100"> </td> 94 <th> 95<a href="../../../../nn/cec/CTR/MessageBox/ReadMessage.html"><CODE>ReadMessage</CODE></a> 96 </th> 97<td>Reads a <a href="../../../../nn/cec/CTR/Message/Overview.html">Message</a>.</td> 98 </tr> 99 <tr> 100 <td width="100"> </td> 101 <th> 102<a href="../../../../nn/cec/CTR/MessageBox/WriteMessage.html"><CODE>WriteMessage</CODE></a> 103 </th> 104<td>Writes a <a href="../../../../nn/cec/CTR/Message/Overview.html">Message</a> to the system save region.</td> 105 </tr> 106 <tr> 107 <td width="100"> </td> 108 <th> 109<a href="../../../../nn/cec/CTR/MessageBox/DeleteMessage.html"><CODE>DeleteMessage</CODE></a> 110 </th> 111<td>Deletes a <a href="../../../../nn/cec/CTR/Message/Overview.html">Message</a>.</td> 112 </tr> 113 <tr> 114<th class="category" colspan="3">Controlling Boxes and Getting Information</th> 115 </tr> 116 <tr> 117 <td width="100"> </td> 118 <th> 119<a href="../../../../nn/cec/CTR/MessageBox/GetMessageBoxData.html"><CODE>GetMessageBoxData</CODE></a> 120 </th> 121<td>Gets the data associated with a <CODE><a href="../../../../nn/cec/CTR/MessageBox/Overview.html">MessageBox</a></CODE>.</td> 122 </tr> 123 <tr> 124 <td width="100"> </td> 125 <th> 126<a href="../../../../nn/cec/CTR/MessageBox/GetMessageBoxDataSize.html"><CODE>GetMessageBoxDataSize</CODE></a> 127 </th> 128<td>Gets the data size associated with a <CODE><a href="../../../../nn/cec/CTR/MessageBox/Overview.html">MessageBox</a></CODE>.</td> 129 </tr> 130 <tr> 131 <td width="100"> </td> 132 <th> 133<a href="../../../../nn/cec/CTR/MessageBox/SetMessageBoxData.html"><CODE>SetMessageBoxData</CODE></a> 134 </th> 135<td>Sets the data associated with a <CODE><a href="../../../../nn/cec/CTR/MessageBox/Overview.html">MessageBox</a></CODE>.</td> 136 </tr> 137 <tr> 138 <td width="100"> </td> 139 <th> 140<a href="../../../../nn/cec/CTR/MessageBox/SetMessageBoxName.html"><CODE>SetMessageBoxName</CODE></a> 141 </th> 142<td>Sets a <CODE><a href="../../../../nn/cec/CTR/MessageBox/Overview.html">MessageBox</a></CODE>'s name.</td> 143 </tr> 144 <tr> 145 <td width="100"> </td> 146 <th> 147<a href="../../../../nn/cec/CTR/MessageBox/SetMessageBoxIcon.html"><CODE>SetMessageBoxIcon</CODE></a> 148 </th> 149<td>Sets a <CODE><a href="../../../../nn/cec/CTR/MessageBox/Overview.html">MessageBox</a></CODE>'s icon.</td> 150 </tr> 151 <tr> 152 <td width="100"> </td> 153 <th> 154<a href="../../../../nn/cec/CTR/MessageBox/GetMessageBoxName.html"><CODE>GetMessageBoxName</CODE></a> 155 </th> 156<td>Gets a <CODE><a href="../../../../nn/cec/CTR/MessageBox/Overview.html">MessageBox</a></CODE>'s name.</td> 157 </tr> 158 <tr> 159 <td width="100"> </td> 160 <th> 161<a href="../../../../nn/cec/CTR/MessageBox/GetMessageBoxIcon.html"><CODE>GetMessageBoxIcon</CODE></a> 162 </th> 163<td>Gets a <CODE><a href="../../../../nn/cec/CTR/MessageBox/Overview.html">MessageBox</a></CODE>'s icon.</td> 164 </tr> 165 <tr> 166<th class="category" colspan="3">Getting Message Box Information</th> 167 </tr> 168 <tr> 169 <td width="100"> </td> 170 <th> 171<a href="../../../../nn/cec/CTR/MessageBox/GetBoxFlag.html"><CODE>GetBoxFlag</CODE></a> 172 </th> 173<td>Gets the attributes of a <CODE><a href="../../../../nn/cec/CTR/MessageBox/Overview.html">MessageBox</a></CODE>.</td> 174 </tr> 175 <tr> 176 <td width="100"> </td> 177 <th> 178<a href="../../../../nn/cec/CTR/MessageBox/GetBoxSizeMax.html"><CODE>GetBoxSizeMax</CODE></a> 179 </th> 180<td>Gets the capacity of the inbox or outbox.</td> 181 </tr> 182 <tr> 183 <td width="100"> </td> 184 <th> 185<a href="../../../../nn/cec/CTR/MessageBox/GetBoxSize.html"><CODE>GetBoxSize</CODE></a> 186 </th> 187<td>Gets the current size of the inbox or outbox.</td> 188 </tr> 189 <tr> 190 <td width="100"> </td> 191 <th> 192<a href="../../../../nn/cec/CTR/MessageBox/GetBoxMessNumMax.html"><CODE>GetBoxMessNumMax</CODE></a> 193 </th> 194<td>Gets the maximum number of <a href="../../../../nn/cec/CTR/Message/Overview.html">Messages</a> in the inbox or outbox.</td> 195 </tr> 196 <tr> 197 <td width="100"> </td> 198 <th> 199<a href="../../../../nn/cec/CTR/MessageBox/GetBoxMessNum.html"><CODE>GetBoxMessNum</CODE></a> 200 </th> 201<td>Gets the number of <a href="../../../../nn/cec/CTR/Message/Overview.html">Messages</a> in the inbox or outbox.</td> 202 </tr> 203 <tr> 204 <td width="100"> </td> 205 <th> 206<a href="../../../../nn/cec/CTR/MessageBox/GetBoxGroupNumMax.html"><CODE>GetBoxGroupNumMax</CODE></a> 207 </th> 208<td>Gets the maximum number of <a href="../../../../nn/cec/CTR/Message/Overview.html">Message</a> groups in the inbox or outbox.</td> 209 </tr> 210 <tr> 211 <td width="100"> </td> 212 <th> 213<a href="../../../../nn/cec/CTR/MessageBox/GetBoxGroupNum.html"><CODE>GetBoxGroupNum</CODE></a> 214 </th> 215<td>Gets the number of <a href="../../../../nn/cec/CTR/Message/Overview.html">Message</a> groups in the inbox or outbox.</td> 216 </tr> 217 <tr> 218 <td width="100"> </td> 219 <th> 220<a href="../../../../nn/cec/CTR/MessageBox/SetBoxGroupNumMax.html"><CODE>SetBoxGroupNumMax</CODE></a> 221 </th> 222<td>Sets the maximum number of <a href="../../../../nn/cec/CTR/Message/Overview.html">Message</a> groups in the inbox or outbox.</td> 223 </tr> 224 <tr> 225 <td width="100"> </td> 226 <th> 227<a href="../../../../nn/cec/CTR/MessageBox/GetBoxSessionNum.html"><CODE>GetBoxSessionNum</CODE></a> 228 </th> 229<td>Gets the Session ID count for (the number of items received in) the inbox.</td> 230 </tr> 231 <tr> 232<th class="category" colspan="3">Getting Message Information (old API)</th> 233 </tr> 234 <tr> 235 <td width="100"> </td> 236 <th> 237<a href="../../../../nn/cec/CTR/MessageBox/GetInBoxMessIdByIndex.html"><CODE>GetInBoxMessIdByIndex</CODE></a> 238 </th> 239<td>Gets the <CODE>MessageID</CODE> of the <CODE>n</CODE>th <a href="../../../../nn/cec/CTR/Message/Overview.html">Message</a> in the inbox.</td> 240 </tr> 241 <tr> 242 <td width="100"> </td> 243 <th> 244<a href="../../../../nn/cec/CTR/MessageBox/GetOutBoxMessIdByIndex.html"><CODE>GetOutBoxMessIdByIndex</CODE></a> 245 </th> 246<td>Gets the <CODE>MessageID</CODE> of the <CODE>n</CODE>th <a href="../../../../nn/cec/CTR/Message/Overview.html">Message</a> in the outbox.</td> 247 </tr> 248 <tr> 249 <td width="100"> </td> 250 <th> 251<a href="../../../../nn/cec/CTR/MessageBox/GetMessSizeByMessId.html"><CODE>GetMessSizeByMessId</CODE></a> 252 </th> 253<td>Gets the size of the <a href="../../../../nn/cec/CTR/Message/Overview.html">Message</a> with the specified <CODE>MessageID</CODE>.</td> 254 </tr> 255 <tr> 256<th class="category" colspan="3">Getting Message Information</th> 257 </tr> 258 <tr> 259 <td width="100"> </td> 260 <th> 261<a href="../../../../nn/cec/CTR/MessageBox/GetMessageMessSize.html"><CODE>GetMessageMessSize</CODE></a> 262 </th> 263<td>Gets the size of a message.</td> 264 </tr> 265 <tr> 266 <td width="100"> </td> 267 <th> 268<a href="../../../../nn/cec/CTR/MessageBox/GetMessageBodySize.html"><CODE>GetMessageBodySize</CODE></a> 269 </th> 270<td>Gets the size of a message's body.</td> 271 </tr> 272 <tr> 273 <td width="100"> </td> 274 <th> 275<a href="../../../../nn/cec/CTR/MessageBox/GetMessageGroupId.html"><CODE>GetMessageGroupId</CODE></a> 276 </th> 277<td>Gets the group ID of a message.</td> 278 </tr> 279 <tr> 280 <td width="100"> </td> 281 <th> 282<a href="../../../../nn/cec/CTR/MessageBox/GetMessageSessionId.html"><CODE>GetMessageSessionId</CODE></a> 283 </th> 284<td>Gets an inbox message's Session ID. (The ID assigned when received.)</td> 285 </tr> 286 <tr> 287 <td width="100"> </td> 288 <th> 289<a href="../../../../nn/cec/CTR/MessageBox/GetMessageMessTypeFlag.html"><CODE>GetMessageMessTypeFlag</CODE></a> 290 </th> 291<td>Gets the <CODE>CecMessageTypeFlag</CODE> of a message.</td> 292 </tr> 293 <tr> 294 <td width="100"> </td> 295 <th> 296<a href="../../../../nn/cec/CTR/MessageBox/GetMessageSendMode.html"><CODE>GetMessageSendMode</CODE></a> 297 </th> 298<td>Gets the <CODE><a href="../../../../nn/cec/CTR/SendMode.html">SendMode</a></CODE> of a message.</td> 299 </tr> 300 <tr> 301 <td width="100"> </td> 302 <th> 303<a href="../../../../nn/cec/CTR/MessageBox/GetMessageSendCount.html"><CODE>GetMessageSendCount</CODE></a> 304 </th> 305<td>Gets the send count of a message.</td> 306 </tr> 307 <tr> 308 <td width="100"> </td> 309 <th> 310<a href="../../../../nn/cec/CTR/MessageBox/GetMessagePropagationCount.html"><CODE>GetMessagePropagationCount</CODE></a> 311 </th> 312<td>Gets the propagation count of a message.</td> 313 </tr> 314 <tr> 315 <td width="100"> </td> 316 <th> 317<a href="../../../../nn/cec/CTR/MessageBox/GetMessageTag.html"><CODE>GetMessageTag</CODE></a> 318 </th> 319<td>Gets the message tag of a message.</td> 320 </tr> 321 <tr> 322 <td width="100"> </td> 323 <th> 324<a href="../../../../nn/cec/CTR/MessageBox/GetMessageSendDate.html"><CODE>GetMessageSendDate</CODE></a> 325 </th> 326<td>Gets the timestamp of when a received message was sent.</td> 327 </tr> 328 <tr> 329 <td width="100"> </td> 330 <th> 331<a href="../../../../nn/cec/CTR/MessageBox/GetMessageRecvDate.html"><CODE>GetMessageRecvDate</CODE></a> 332 </th> 333<td>Gets the timestamp of when a message was received.</td> 334 </tr> 335 <tr> 336 <td width="100"> </td> 337 <th> 338<a href="../../../../nn/cec/CTR/MessageBox/GetMessageCreateDate.html"><CODE>GetMessageCreateDate</CODE></a> 339 </th> 340<td>Gets the timestamp of when a message was created.</td> 341 </tr> 342 <tr> 343 <td width="100"> </td> 344 <th> 345<a href="../../../../nn/cec/CTR/MessageBox/GetMessageMessIdPair.html"><CODE>GetMessageMessIdPair</CODE></a> 346 </th> 347<td>Gets the pair of <CODE>MessageID</CODE>s corresponding to a message exchange.</td> 348 </tr> 349 <tr> 350 <td width="100"> </td> 351 <th> 352<a href="../../../../nn/cec/CTR/MessageBox/GetMessageMessId.html"><CODE>GetMessageMessId</CODE></a> 353 </th> 354<td>Gets the <CODE>MessageID</CODE> of a message.</td> 355 </tr> 356 <tr> 357 <td width="100"> </td> 358 <th> 359<a href="../../../../nn/cec/CTR/MessageBox/GetMessIndex.html"><CODE>GetMessIndex</CODE></a> 360 </th> 361<td>Gets a message's index (<CODE>messIndex</CODE>) based on its <CODE>MessageID</CODE>.</td> 362 </tr> 363 <tr> 364<th class="category" colspan="3">Other</th> 365 </tr> 366 <tr> 367 <td width="100"> </td> 368 <th> 369<a href="../../../../nn/cec/CTR/MessageBox/SetBoxActivate.html"><CODE>SetBoxActivate</CODE></a> 370 </th> 371<td>Specifies whether a <CODE><a href="../../../../nn/cec/CTR/MessageBox/Overview.html">MessageBox</a></CODE> is enabled or disabled. A disabled box will not have any data sent or received.</td> 372 </tr> 373 <tr> 374 <td width="100"> </td> 375 <th> 376<a href="../../../../nn/cec/CTR/MessageBox/GetBoxActivate.html"><CODE>GetBoxActivate</CODE></a> 377 </th> 378<td>Gets whether a <CODE><a href="../../../../nn/cec/CTR/MessageBox/Overview.html">MessageBox</a></CODE> is enabled or disabled. A disabled box will not have any data sent or received.</td> 379 </tr> 380 <tr> 381 <td width="100"> </td> 382 <th> 383<a href="../../../../nn/cec/CTR/MessageBox/RoundOutBoxIndex.html"><CODE>RoundOutBoxIndex</CODE></a> 384 </th> 385<td>Moves the <a href="../../../../nn/cec/CTR/Message/Overview.html">Message</a> with the specified <CODE>MessageID</CODE> to the end of the outbox's outgoing message queue.( The queue order is automatically changed when a <a href="../../../../nn/cec/CTR/Message/Overview.html">message</a> is sent, so there is normally no need to call this function.)</td> 386 </tr> </table> 387 </div> 388 </a> 389<h2>Revision History</h2> 390 <div class="section"> 391 <dl class="history"> 392 <dt>2010/08/16</dt> 393<dd>Initial version.<br /> 394 </dd> 395 </dl> 396 </div> 397 <hr><p>CONFIDENTIAL</p></body> 398</html>