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::MessageBoxInfoReader</title> 51 </head> 52 <body> 53<h1><CODE>nn::cec::CTR::MessageBoxInfoReader</CODE> Class</h1> 54<h2>Syntax</h2> 55 <div class="section"> 56 <pre class="definition">class MessageBoxInfoReader</pre> 57 </div> 58<h2>Description</h2> 59 <div class="section"> 60<p>Gets the header information for a box's message. It can be used in cases such as when getting a list of messages.</p><p>It cannot be used to read the body of a message or an extended header (containing icons, for example). You must use the <CODE><a href="../../../../nn/cec/CTR/Message/Overview.html">Message</a></CODE> class to read such data.</p><p>The features of this class have been integrated into the <a href="../../../../nn/cec/CTR/MessageBox/Overview.html"><CODE>MessageBox</CODE></a> class. This class is scheduled to be removed from the library.</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">Initialization</th> 67 </tr> 68 <tr> 69 <td width="100"> </td> 70 <th> 71<a href="../../../../nn/cec/CTR/MessageBoxInfoReader/MessageBoxInfoReader.html">MessageBoxInfoReader</a> 72 </th> 73<td>Constructor. This loads box information for the specified <a href="../../../../nn/cec/CTR/MessageBox/Overview.html"><CODE>MessageBox</CODE></a> object. The specified message box must be open.</td> 74 </tr> 75 <tr> 76 <td width="100"> </td> 77 <th> 78<a href="../../../../nn/cec/CTR/MessageBoxInfoReader/LoadMessageBoxInfo.html">LoadMessageBoxInfo</a> 79 </th> 80<td>Loads the box information by specifying the <CODE><a href="../../../../nn/cec/CTR/MessageBox/Overview.html">MessageBox</a></CODE> object. The specified message box must be open.</td> 81 </tr> 82 <tr> 83<th class="category" colspan="3">Getting Message Box Information</th> 84 </tr> 85 <tr> 86 <td width="100"> </td> 87 <th> 88<a href="../../../../nn/cec/CTR/MessageBoxInfoReader/GetMessageBoxInfoFlag.html">GetMessageBoxInfoFlag</a> 89 </th> 90<td>Gets a <CODE><a href="../../../../nn/cec/CTR/MessageBox/Overview.html">MessageBoxFlag</a></CODE>.</td> 91 </tr> 92 <tr> 93 <td width="100"> </td> 94 <th> 95<a href="../../../../nn/cec/CTR/MessageBoxInfoReader/GetBoxSizeMax.html"><CODE>GetBoxSizeMax</CODE></a> 96 </th> 97<td>Gets the maximum box capacity.</td> 98 </tr> 99 <tr> 100 <td width="100"> </td> 101 <th> 102<a href="../../../../nn/cec/CTR/MessageBoxInfoReader/GetBoxSize.html"><CODE>GetBoxSize</CODE></a> 103 </th> 104<td>Gets the box capacity being used.</td> 105 </tr> 106 <tr> 107 <td width="100"> </td> 108 <th> 109<a href="../../../../nn/cec/CTR/MessageBoxInfoReader/GetMessNumMax.html">GetMessNumMax</a> 110 </th> 111<td>Gets the maximum number of messages a box can contain.</td> 112 </tr> 113 <tr> 114 <td width="100"> </td> 115 <th> 116<a href="../../../../nn/cec/CTR/MessageBoxInfoReader/GetMessNum.html">GetMessNum</a> 117 </th> 118<td>Gets the number of messages in a box.</td> 119 </tr> 120 <tr> 121<th class="category" colspan="3">Getting Message Information</th> 122 </tr> 123 <tr> 124 <td width="100"> </td> 125 <th> 126<a href="../../../../nn/cec/CTR/MessageBoxInfoReader/GetMessageMessSize.html"><CODE>GetMessageMessSize</CODE></a> 127 </th> 128<td>Gets the size of a message.</td> 129 </tr> 130 <tr> 131 <td width="100"> </td> 132 <th> 133<a href="../../../../nn/cec/CTR/MessageBoxInfoReader/GetMessageBodySize.html"><CODE>GetMessageBodySize</CODE></a> 134 </th> 135<td>Gets the size of a message's body.</td> 136 </tr> 137 <tr> 138 <td width="100"> </td> 139 <th> 140<a href="../../../../nn/cec/CTR/MessageBoxInfoReader/GetMessageGroupId.html"><CODE>GetMessageGroupId</CODE></a> 141 </th> 142<td>Gets the group ID of a message.</td> 143 </tr> 144 <tr> 145 <td width="100"> </td> 146 <th> 147<a href="../../../../nn/cec/CTR/MessageBoxInfoReader/GetMessageSessionId.html"><CODE>GetMessageSessionId</CODE></a> 148 </th> 149<td>Gets an inbox message's session ID. (The ID assigned when received.)</td> 150 </tr> 151 <tr> 152 <td width="100"> </td> 153 <th> 154<a href="../../../../nn/cec/CTR/MessageBoxInfoReader/GetMessageMessTypeFlag.html"><CODE>GetMessageMessTypeFlag</CODE></a> 155 </th> 156<td>Gets the <CODE>CecMessageTypeFlag</CODE> of a message.</td> 157 </tr> 158 <tr> 159 <td width="100"> </td> 160 <th> 161<a href="../../../../nn/cec/CTR/MessageBoxInfoReader/GetMessageSendMode.html"><CODE>GetMessageSendMode</CODE></a> 162 </th> 163<td>Gets the <CODE><a href="../../../../nn/cec/CTR/SendMode.html">SendMode</a></CODE> of a message.</td> 164 </tr> 165 <tr> 166 <td width="100"> </td> 167 <th> 168<a href="../../../../nn/cec/CTR/MessageBoxInfoReader/GetMessageSendCount.html"><CODE>GetMessageSendCount</CODE></a> 169 </th> 170<td>Gets the send count of a message.</td> 171 </tr> 172 <tr> 173 <td width="100"> </td> 174 <th> 175<a href="../../../../nn/cec/CTR/MessageBoxInfoReader/GetMessagePropagationCount.html"><CODE>GetMessagePropagationCount</CODE></a> 176 </th> 177<td>Gets the propagation count of a message.</td> 178 </tr> 179 <tr> 180 <td width="100"> </td> 181 <th> 182<a href="../../../../nn/cec/CTR/MessageBoxInfoReader/GetMessageFlag_Unread.html">GetMessageFlag_Unread</a> 183 </th> 184<td>Gets the unread flag of a message.</td> 185 </tr> 186 <tr> 187 <td width="100"> </td> 188 <th> 189<a href="../../../../nn/cec/CTR/MessageBoxInfoReader/GetMessageFlag_New.html">GetMessageFlag_New</a> 190 </th> 191<td>Gets the new arrival flag of a message.</td> 192 </tr> 193 <tr> 194 <td width="100"> </td> 195 <th> 196<a href="../../../../nn/cec/CTR/MessageBoxInfoReader/GetMessageTag.html"><CODE>GetMessageTag</CODE></a> 197 </th> 198<td>Gets the message tag of a message.</td> 199 </tr> 200 <tr> 201 <td width="100"> </td> 202 <th> 203<a href="../../../../nn/cec/CTR/MessageBoxInfoReader/GetMessageSendDate.html"><CODE>GetMessageSendDate</CODE></a> 204 </th> 205<td>Gets the timestamp of when a received message was sent.</td> 206 </tr> 207 <tr> 208 <td width="100"> </td> 209 <th> 210<a href="../../../../nn/cec/CTR/MessageBoxInfoReader/GetMessageRecvDate.html"><CODE>GetMessageRecvDate</CODE></a> 211 </th> 212<td>Gets the timestamp of when a message was received.</td> 213 </tr> 214 <tr> 215 <td width="100"> </td> 216 <th> 217<a href="../../../../nn/cec/CTR/MessageBoxInfoReader/GetMessageCreateDate.html"><CODE>GetMessageCreateDate</CODE></a> 218 </th> 219<td>Gets the timestamp of when a message was created.</td> 220 </tr> 221 <tr> 222 <td width="100"> </td> 223 <th> 224<a href="../../../../nn/cec/CTR/MessageBoxInfoReader/GetMessageMessIdPair.html"><CODE>GetMessageMessIdPair</CODE></a> 225 </th> 226<td>Gets the pair of <CODE>MessageID</CODE>s corresponding to a message exchange.</td> 227 </tr> 228 <tr> 229 <td width="100"> </td> 230 <th> 231<a href="../../../../nn/cec/CTR/MessageBoxInfoReader/GetMessageMessId.html"><CODE>GetMessageMessId</CODE></a> 232 </th> 233<td>Gets the <CODE>MessageID</CODE> of a message.</td> 234 </tr> 235 <tr> 236 <td width="100"> </td> 237 <th> 238<a href="../../../../nn/cec/CTR/MessageBoxInfoReader/GetMessIndex.html"><CODE>GetMessIndex</CODE></a> 239 </th> 240<td>Gets a message's index (<CODE>messIndex</CODE>) based on its <CODE>MessageID</CODE>.</td> 241 </tr> </table> 242 </div> 243 </a> 244<h2>Revision History</h2> 245 <div class="section"> 246 <dl class="history"> 247 <dt>2010/08/16</dt> 248<dd>Initial version.<br /> 249 </dd> 250 </dl> 251 </div> 252 <hr><p>CONFIDENTIAL</p></body> 253</html>