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::pl::CTR</title> 51 </head> 52 <body> 53<h1><CODE><a href="../../../nn/Overview.html">nn</a>::<a href="../../../nn/pl/Overview.html">pl</a>::CTR</CODE> Namespace</h1> 54<h2>Description</h2> 55 <div class="section"> 56<p>Namespace for <a href="../../../nn/pl/CTR/Overview.html">CTR</a>-specific API functions.</p><p>(This can also be written without the "::CTR" portion.))</p>Use the <CODE>nn::ptm::CTR::Initialize</CODE> and <CODE>nn::ptm::CTR::Finalize</CODE> functions to initialize and finalize the Pedometer library.</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/pl/CTR/ResultIsWriting/Overview.html"><CODE>nn::pl::CTR::ResultIsWriting</CODE></a> 64 </th> 65<td>Indicates that step count data is currently being written. Try again in a little while.</td> 66 </tr> </table> 67 </div> 68 </a> <a name="struct" id="struct"> 69<h2>Structures</h2> 70 <div class="section"> 71 <table class="members"> 72 <tr> 73 <th> 74<a href="../../../nn/pl/CTR/PedometerMonthHeader/Overview.html"><CODE>nn::pl::CTR::PedometerMonthHeader</CODE></a> 75 </th> 76<td>Structure that holds the recorded year and month for step count entries.</td> 77 </tr> 78 <tr> 79 <th> 80<a href="../../../nn/pl/CTR/PedometerHistoryHeader/Overview.html"><CODE>nn::pl::CTR::PedometerHistoryHeader</CODE></a> 81 </th> 82<td>Structure that indicates the header information for step count data.</td> 83 </tr> 84 <tr> 85 <th> 86<a href="../../../nn/pl/CTR/PedometerEntry/Overview.html"><CODE>nn::pl::CTR::PedometerEntry</CODE></a> 87 </th> 88<td>The structure for the entry that indicates the year and month that step counts were recorded.</td> 89 </tr> </table> 90 </div> 91 </a> <a name="enum" id="enum"> 92<h2>Enumerated Types</h2> 93 <div class="section"> 94 <table class="members"> 95 <tr> 96<th class="category" colspan="3">Shared Fonts</th> 97 </tr> 98 <tr> 99 <td width="100"> </td> 100 <th> 101<a href="../../../nn/pl/CTR/SharedFontType.html"><CODE>SharedFontType</CODE></a> 102 </th> 103<td>Indicates the type of shared font.</td> 104 </tr> 105 <tr> 106 <td width="100"> </td> 107 <th> 108<a href="../../../nn/pl/CTR/SharedFontLoadState.html"><CODE>SharedFontLoadState</CODE></a> 109 </th> 110<td>Indicates the load state of the shared font.</td> 111 </tr> </table> 112 </div> 113 </a> <a name="typedef" id="typedef"> 114<h2><CODE>typedef</CODE> Definitions</h2> 115 <div class="section"> 116 <table class="members"> 117 <tr> 118<th class="category" colspan="3">Pedometer Library</th> 119 </tr> 120 <tr> 121 <td width="100" /> 122 <th> 123<a href="../../../nn/pl/CTR/PedometerMonthData.html"><CODE>PedometerMonthData</CODE></a> 124 </th> 125<td>Type that stores one month's worth of step counts.</td> 126 </tr> 127 <tr> 128 <td width="100" /> 129 <th> 130<a href="../../../nn/pl/CTR/PedometerHistoryData.html"><CODE>PedometerHistoryData</CODE></a> 131 </th> 132<td>Type that stores all step count data (10 years' worth) stored by the Pedometer library.</td> 133 </tr> </table> 134 </div> 135 </a> <a name="constant" id="constant"> 136<h2>Constants</h2> 137 <div class="section"> 138 <table class="members"> 139 <tr> 140<th class="category" colspan="4">Pedometer Library</th> 141 </tr> 142 <tr> 143 <td width="100"> </td> 144 <th> 145<span class="argument"><a href="../../../nn/pl/CTR/MAX_MONTHDAYS.html"><CODE>MAX_MONTHDAYS</CODE></a></span> 146 </th> 147<td width="100">const <a href="../../../nn_types/s32.html">s32</a></td> 148<td>The number of days saved in entries in a single month.</td> 149 </tr> 150 <tr> 151 <td width="100"> </td> 152 <th> 153<span class="argument"><a href="../../../nn/pl/CTR/DAYHOURS.html"><CODE>DAYHOURS</CODE></a></span> 154 </th> 155<td width="100">const <a href="../../../nn_types/s32.html">s32</a></td> 156<td>The number of hours saved in entries in a single day.</td> 157 </tr> 158 <tr> 159 <td width="100"> </td> 160 <th> 161<span class="argument"><a href="../../../nn/pl/CTR/NUM_FREESPACE.html"><CODE>NUM_FREESPACE</CODE></a></span> 162 </th> 163<td width="100">const <a href="../../../nn_types/s32.html">s32</a></td> 164<td>Number of entries, used internally.</td> 165 </tr> 166 <tr> 167 <td width="100"> </td> 168 <th> 169<span class="argument"><a href="../../../nn/pl/CTR/NUM_MONTHHISTORIES.html"><CODE>NUM_MONTHHISTORIES</CODE></a></span> 170 </th> 171<td width="100">const <a href="../../../nn_types/s32.html">s32</a></td> 172<td>The maximum number of entries per month saved by the Pedometer library.</td> 173 </tr> 174 <tr> 175 <td width="100"> </td> 176 <th> 177<span class="argument"><a href="../../../nn/pl/CTR/MAX_MONTHHISTORIES.html"><CODE>MAX_MONTHHISTORIES</CODE></a></span> 178 </th> 179<td width="100">const <a href="../../../nn_types/s32.html">s32</a></td> 180<td>The internally saved number of entries per month.</td> 181 </tr> 182 <tr> 183 <td width="100"> </td> 184 <th> 185<span class="argument"><a href="../../../nn/pl/CTR/NUM_MONTHHISTORYENTRIES.html"><CODE>NUM_MONTHHISTORYENTRIES</CODE></a></span> 186 </th> 187<td width="100">const <a href="../../../nn_types/s32.html">s32</a></td> 188<td>The number of data instances saved per month.</td> 189 </tr> 190 <tr> 191 <td width="100"> </td> 192 <th> 193<span class="argument"><a href="../../../nn/pl/CTR/INVALID_COUNTER.html"><CODE>INVALID_COUNTER</CODE></a></span> 194 </th> 195<td width="100">const <a href="../../../nn_types/u16.html">u16</a></td> 196<td>A value that indicates an invalid entry.</td> 197 </tr> 198 <tr> 199<th class="category" colspan="4">Play Coins Library</th> 200 </tr> 201 <tr> 202 <td width="100"> </td> 203 <th> 204<span class="argument"><a href="../../../nn/pl/CTR/MAX_GAME_COIN_COUNT.html"><CODE>MAX_GAME_COIN_COUNT</CODE></a></span> 205 </th> 206<td width="100">const <a href="../../../nn_types/u16.html">u16</a></td> 207<td>The maximum number of Play Coins the user can own.</td> 208 </tr> </table> 209 </div> 210 </a> <a name="function" id="function"> 211<h2>Functions</h2> 212 <div class="section"> 213 <table class="members"> 214 <tr> 215<th class="category" colspan="3">Pedometer Library</th> 216 </tr> 217 <tr> 218 <td width="100"> </td> 219 <th> 220<a href="../../../nn/pl/CTR/GetPedometerState.html"><CODE>GetPedometerState</CODE></a> 221 </th> 222<td>Returns the status of the pedometer.</td> 223 </tr> 224 <tr> 225 <td width="100"> </td> 226 <th> 227<a href="../../../nn/pl/CTR/GetStepHistoryEntry.html"><CODE>GetStepHistoryEntry</CODE></a> 228 </th> 229<td>Gets the entry information for the step counts recorded by the library.</td> 230 </tr> 231 <tr> 232 <td width="100"> </td> 233 <th> 234<a href="../../../nn/pl/CTR/GetStepHistory.html"><CODE>GetStepHistory</CODE></a> 235 </th> 236<td>Gets the number of steps recorded for each hour.</td> 237 </tr> 238 <tr> 239 <td width="100"> </td> 240 <th> 241<a href="../../../nn/pl/CTR/GetTotalStepCount.html"><CODE>GetTotalStepCount</CODE></a> 242 </th> 243<td>Gets the total number of steps.</td> 244 </tr> 245 <tr> 246 <td width="100"> </td> 247 <th> 248<a href="../../../nn/pl/CTR/GetStepHistoryAll.html"><CODE>GetStepHistoryAll</CODE></a> 249 </th> 250<td>Gets all step count data saved by the library.</td> 251 </tr> 252 <tr> 253<th class="category" colspan="3">Shared Fonts</th> 254 </tr> 255 <tr> 256 <td width="100"> </td> 257 <th> 258<a href="../../../nn/pl/CTR/InitializeSharedFont.html"><CODE>InitializeSharedFont</CODE></a> 259 </th> 260<td>Enables use of shared font.</td> 261 </tr> 262 <tr> 263 <td width="100"> </td> 264 <th> 265<a href="../../../nn/pl/CTR/GetSharedFontAddress.html"><CODE>GetSharedFontAddress</CODE></a> 266 </th> 267<td>Gets the address of the shared font.</td> 268 </tr> 269 <tr> 270 <td width="100"> </td> 271 <th> 272<a href="../../../nn/pl/CTR/GetSharedFontSize.html"><CODE>GetSharedFontSize</CODE></a> 273 </th> 274<td>Gets the size of the shared font.</td> 275 </tr> 276 <tr> 277 <td width="100"> </td> 278 <th> 279<a href="../../../nn/pl/CTR/GetSharedFontType.html"><CODE>GetSharedFontType</CODE></a> 280 </th> 281<td>Gets the type of the shared font.</td> 282 </tr> 283 <tr> 284 <td width="100"> </td> 285 <th> 286<a href="../../../nn/pl/CTR/GetSharedFontLoadState.html"><CODE>GetSharedFontLoadState</CODE></a> 287 </th> 288<td>Gets the load state of the shared font.</td> 289 </tr> 290 <tr> 291 <td width="100"> </td> 292 <th> 293<a href="../../../nn/pl/CTR/MountSharedFont.html"><CODE>MountSharedFont</CODE></a> 294 </th> 295<td>Mounts the archive of the shared font.</td> 296 </tr> 297 <tr> 298 <td width="100"> </td> 299 <th> 300<a href="../../../nn/pl/CTR/UnmountSharedFont.html"><CODE>UnmountSharedFont</CODE></a> 301 </th> 302<td>Unmounts the archive of the shared font.</td> 303 </tr> 304 <tr> 305<th class="category" colspan="3">Play Coins Library</th> 306 </tr> 307 <tr> 308 <td width="100"> </td> 309 <th> 310<a href="../../../nn/pl/CTR/InitializeGameCoin.html"><CODE>InitializeGameCoin</CODE></a> 311 </th> 312<td>Initializes the Play Coins library.</td> 313 </tr> 314 <tr> 315 <td width="100"> </td> 316 <th> 317<a href="../../../nn/pl/CTR/FinalizeGameCoin.html"><CODE>FinalizeGameCoin</CODE></a> 318 </th> 319<td>Finalizes the Play Coins library.</td> 320 </tr> 321 <tr> 322 <td width="100"> </td> 323 <th> 324<a href="../../../nn/pl/CTR/GetGameCoinCount.html"><CODE>GetGameCoinCount</CODE></a> 325 </th> 326<td>Gets the current number of Play Coins owned.</td> 327 </tr> 328 <tr> 329 <td width="100"> </td> 330 <th> 331<a href="../../../nn/pl/CTR/UseGameCoin.html"><CODE>UseGameCoin</CODE></a> 332 </th> 333<td>Consumes (spends) only the specified number of Play Coins.</td> 334 </tr> </table> 335 </div> 336 </a> 337<h2>Revision History</h2> 338 <div class="section"> 339 <dl class="history"> 340 <dt>2011/08/19</dt> 341<dd>Added description of the Play Coins library.<br /> 342 </dd> 343 <dt>2010/11/16</dt> 344<dd>Added description of how to initialize and finalize the Pedometer library.<br /> 345 </dd> 346 <dt>2010/09/02</dt> 347<dd>Initial version.<br /> 348 </dd> 349 </dl> 350 </div> 351 <hr><p>CONFIDENTIAL</p></body> 352</html>