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</title> 51 </head> 52 <body> 53<h1><CODE>nn::cec::CTR</CODE> Namespace</h1> 54<h2>Description</h2> 55 <div class="section"> 56<p>Namespace for the CEC library. <br />(This namespace can also be written without the "<CODE>::CTR</CODE>" portion.)</p><!-- write here --></div> 57 <a name="class" id="class"> 58<h2>Classes</h2> 59 <div class="section"> 60 <table class="members"> 61 <tr> 62 <th> 63<a href="../../../nn/cec/CTR/CecControl/Overview.html"><CODE>nn::cec::CTR::CecControl</CODE></a> 64 </th> 65<td>Returns the Cec state.</td> 66 </tr> 67 <tr> 68 <th> 69<a href="../../../nn/cec/CTR/Message/Overview.html"><CODE>nn::cec::CTR::Message</CODE></a> 70 </th> 71<td>Class that handles CEC <CODE>Message</CODE> objects.</td> 72 </tr> 73 <tr> 74 <th> 75<a href="../../../nn/cec/CTR/MessageBox/Overview.html"><CODE>nn::cec::CTR::MessageBox</CODE></a> 76 </th> 77<td>Class for accessing CEC <CODE>MessageBox</CODE> objects.</td> 78 </tr> 79 <tr> 80 <th> 81<a href="../../../nn/cec/CTR/MessageBoxInfoReader/Overview.html"><CODE>nn::cec::CTR::MessageBoxInfoReader</CODE></a> 82 </th> 83<td>Gets the header information for a box's message. Can be used in cases such as when getting a list of messages.</td> 84 </tr> 85 <tr> 86 <th> 87<a href="../../../nn/cec/CTR/MessageId/Overview.html"><CODE>nn::cec::CTR::MessageId</CODE></a> 88 </th> 89<td>Message ID</td> 90 </tr> 91 </table> 92 </div> 93 </a> <a name="struct" id="struct"> 94<h2>Structures</h2> 95 <div class="section"> 96 <table class="members"> 97 <tr> 98 <th> 99<a href="../../../nn/cec/CTR/CecNotificationParam/Overview.html"><CODE>nn::cec::CTR::CecNotificationParam</CODE></a> 100 </th> 101<td>Receive information for each box.</td> 102 </tr> 103 <tr> 104 <th> 105<a href="../../../nn/cec/CTR/CecNotificationData/Overview.html"><CODE>nn::cec::CTR::CecNotificationData</CODE></a> 106 </th> 107<td>Receive information.</td> 108 </tr> 109 </table> 110 </div> 111 </a> <a name="enum" id="enum"> 112<h2>Enumerated Types</h2> 113 <div class="section"> 114 <table class="members"> 115 <tr> 116 <td width="100"> </td> 117 <th> 118<a href="../../../nn/cec/CTR/CecBoxDataType.html"><CODE>CecBoxDataType</CODE></a> 119 </th> 120<td>Indicates the types of data associated with boxes.</td> 121 </tr> 122 <tr> 123 <td width="100"> </td> 124 <th> 125<a href="../../../nn/cec/CTR/CecBoxType.html"><CODE>CecBoxType</CODE></a> 126 </th> 127<td>Types used for inboxes and outboxes.</td> 128 </tr> </table> 129 </div> 130 </a> <a name="typedef" id="typedef"> 131<h2><CODE>typedef</CODE> Definitions</h2> 132 <div class="section"> 133 <table class="members"> 134 <tr> 135<th class="category" colspan="3"><CODE>MessageBoxFlag</CODE></th> 136 </tr> 137 <tr> 138 <td width="100" /> 139 <th> 140<a href="../../../nn/cec/CTR/MessageBoxFlag.html"><CODE>MessageBoxFlag</CODE></a> 141 </th> 142<td>Flag that indicates <CODE><a href="../../../nn/cec/CTR/MessageBox/Overview.html">MessageBox</a></CODE> attributes.</td> 143 </tr> 144 <tr> 145<th class="category" colspan="3"><CODE>SendMode</CODE></th> 146 </tr> 147 <tr> 148 <td width="100" /> 149 <th> 150<a href="../../../nn/cec/CTR/SendMode.html"><CODE>SendMode</CODE></a> 151 </th> 152<td>The sending mode for messages. Specified in a message.</td> 153 </tr> 154 <tr> 155<th class="category" colspan="3"><CODE>MessageTypeFlag</CODE></th> 156 </tr> 157 <tr> 158 <td width="100" /> 159 <th> 160<a href="../../../nn/cec/CTR/MessageTypeFlag.html"><CODE>MessageTypeFlag</CODE></a> 161 </th> 162<td>Flag for switching <a href="../../../nn/cec/CTR/Message/Overview.html">messages</a> depending on the recipient. Specified in a message.</td> 163 </tr> 164 <tr> 165<th class="category" colspan="3"><CODE>MessageExHeaderType</CODE></th> 166 </tr> 167 <tr> 168 <td width="100" /> 169 <th> 170<a href="../../../nn/cec/CTR/MessageExHeaderType.html"><CODE>MessageExHeaderType</CODE></a> 171 </th> 172<td>Data types for a <a href="../../../nn/cec/CTR/Message/Overview.html">message</a>'s extended header.</td> 173 </tr> 174 <tr> 175<th class="category" colspan="3">Other</th> 176 </tr> 177 <tr> 178 <td width="100" /> 179 <th> 180<a href="../../../nn/cec/CTR/TitleId.html"><CODE>TitleId</CODE></a> 181 </th> 182<td><CODE>TitleID</CODE> format.</td> 183 </tr> </table> 184 </div> 185 </a> <a name="constant" id="constant"> 186<h2>Constants</h2> 187 <div class="section"> 188 <table class="members"> 189 <tr> 190<th class="category" colspan="3"><CODE>MessageBoxFlag</CODE></th> 191 </tr> 192 <tr> 193 <td width="100"> 194<span class="static_style" title="static">S</span> 195 </td> 196 <th> 197<span class="argument"><a href="./MESSAGE_BOX_FLAG_APPLICATION.html"><CODE>MESSAGE_BOX_FLAG_APPLICATION</CODE></a></span> 198 </th> 199<td>The value is specified by default for general applications.</td> 200 </tr> 201 <tr> 202<th class="category" colspan="3"><CODE>SendMode</CODE></th> 203 </tr> 204 <tr> 205 <td width="100"> 206<span class="static_style" title="static">S</span> 207 </td> 208 <th> 209<span class="argument"><a href="./SENDMODE_RECV.html"><CODE>SENDMODE_RECV</CODE></a></span> 210 </th> 211<td>Receiving only.</td> 212 </tr> 213 <tr> 214 <td width="100"> 215<span class="static_style" title="static">S</span> 216 </td> 217 <th> 218<span class="argument"><a href="./SENDMODE_SEND.html"><CODE>SENDMODE_SEND</CODE></a></span> 219 </th> 220<td>Sending only.</td> 221 </tr> 222 <tr> 223 <td width="100"> 224<span class="static_style" title="static">S</span> 225 </td> 226 <th> 227<span class="argument"><a href="./SENDMODE_SENDRECV.html"><CODE>SENDMODE_SENDRECV</CODE></a></span> 228 </th> 229<td>Sending and receiving.</td> 230 </tr> 231 <tr> 232 <td width="100"> 233<span class="static_style" title="static">S</span> 234 </td> 235 <th> 236<span class="argument"><a href="./SENDMODE_EXCHANGE.html"><CODE>SENDMODE_EXCHANGE</CODE></a></span> 237 </th> 238<td>Exchange.</td> 239 </tr> 240 <tr> 241<th class="category" colspan="3"><CODE>MessageTypeFlag</CODE></th> 242 </tr> 243 <tr> 244 <td width="100"> 245<span class="static_style" title="static">S</span> 246 </td> 247 <th> 248<span class="argument"><a href="./MESSAGE_TYPEFLAG_NON_FRIEND.html"><CODE>MESSAGE_TYPEFLAG_NON_FRIEND</CODE></a></span> 249 </th> 250<td><I>Non-friends</I> can receive the message.</td> 251 </tr> 252 <tr> 253 <td width="100"> 254<span class="static_style" title="static">S</span> 255 </td> 256 <th> 257<span class="argument"><a href="./MESSAGE_TYPEFLAG_FRIEND.html"><CODE>MESSAGE_TYPEFLAG_FRIEND</CODE></a></span> 258 </th> 259<td><I>Friends</I> can receive the message.</td> 260 </tr> 261 <tr> 262<th class="category" colspan="3"><CODE>MessageExHeaderType</CODE></th> 263 </tr> 264 <tr> 265 <td width="100"> 266<span class="static_style" title="static">S</span> 267 </td> 268 <th> 269<span class="argument"><a href="./MESSAGE_EXHEADER_TYPE_ICON.html"><CODE>MESSAGE_EXHEADER_TYPE_ICON</CODE></a></span> 270 </th> 271<td>The icon for each <a href="../../../nn/cec/CTR/Message/Overview.html">message</a>.</td> 272 </tr> 273 <tr> 274 <td width="100"> 275<span class="static_style" title="static">S</span> 276 </td> 277 <th> 278<span class="argument"><a href="./MESSAGE_EXHEADER_TYPE_INFO.html"><CODE>MESSAGE_EXHEADER_TYPE_INFO</CODE></a></span> 279 </th> 280<td>The data description for each <a href="../../../nn/cec/CTR/Message/Overview.html">message</a>.</td> 281 </tr> 282 <tr> 283<th class="category" colspan="3">Send Count and Propagation Count</th> 284 </tr> 285 <tr> 286 <td width="100"> 287<span class="static_style" title="static">S</span> 288 </td> 289 <th> 290<span class="argument"><a href="./MESSAGE_SENDCOUNT_ONCE.html"><CODE>MESSAGE_SENDCOUNT_ONCE</CODE></a></span> 291 </th> 292<td>Specifies the number of times to send. The message is sent only once.</td> 293 </tr> 294 <tr> 295 <td width="100"> 296<span class="static_style" title="static">S</span> 297 </td> 298 <th> 299<span class="argument"><a href="./MESSAGE_SENDCOUNT_UNLIMITED.html"><CODE>MESSAGE_SENDCOUNT_UNLIMITED</CODE></a></span> 300 </th> 301<td>Specifies the number of times to send. It does not set a limit on the send count.</td> 302 </tr> 303 <tr> 304 <td width="100"> 305<span class="static_style" title="static">S</span> 306 </td> 307 <th> 308<span class="argument"><a href="./MESSAGE_PROPAGATIONCOUNT_ONCE.html"><CODE>MESSAGE_PROPAGATIONCOUNT_ONCE</CODE></a></span> 309 </th> 310<td>Specifies the number of times to propagate. It does not initiate propagation.</td> 311 </tr> 312 <tr> 313<th class="category" colspan="3">Other</th> 314 </tr> 315 <tr> 316 <td width="100"> 317<span class="static_style" title="static">S</span> 318 </td> 319 <th> 320<span class="argument"><a href="./CEC_SIZEOF_MESSAGEID.html"><CODE>CEC_SIZEOF_MESSAGEID</CODE></a></span> 321 </th> 322<td><a href="../../../nn/cec/CTR/MessageId/Overview.html"><CODE>MessageId</CODE></a> size.</td> 323 </tr> </table> 324 </div> 325 </a> <a name="function" id="function"> 326<h2>Functions</h2> 327 <div class="section"> 328 <table class="members"> 329 <tr> 330 <td width="100"> </td> 331 <th> 332<a href="../../../nn/cec/CTR/Initialize.html"><CODE>Initialize</CODE></a> 333 </th> 334<td>Connects to the CEC daemon. This must be called first to allow access to the CEC <a href="../../../nn/cec/CTR/MessageBox/Overview.html"><CODE>MessageBox</CODE></a>.</td> 335 </tr> 336 <tr> 337 <td width="100"> </td> 338 <th> 339<a href="../../../nn/cec/CTR/Finalize.html"><CODE>Finalize</CODE></a> 340 </th> 341<td>Finalizes access to the CEC daemon.</td> 342 </tr> 343 <tr> 344 <td width="100"> </td> 345 <th> 346<a href="../../../nn/cec/CTR/GetCecRecvEventHandle.html"><CODE>GetCecRecvEventHandle</CODE></a> 347 </th> 348<td>Specifies the <CODE>Event</CODE> object to receive reception notifications.</td> 349 </tr> 350 <tr> 351 <td width="100"> </td> 352 <th> 353<a href="../../../nn/cec/CTR/GetCecInfoBuffer.html"><CODE>GetCecInfoBuffer</CODE></a> 354 </th> 355<td>Gets information about a received message.</td> 356 </tr> </table> 357 </div> 358 </a> 359<h2>Revision History</h2> 360 <div class="section"> 361 <dl class="history"> 362 <dt>2010/08/16</dt> 363<dd>Initial version.<br /> 364 </dd> 365 </dl> 366 </div> 367 <hr><p>CONFIDENTIAL</p></body> 368</html>