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::hio::CTR</title> 51 </head> 52 <body> 53<h1><CODE>nn::hio::CTR</CODE> Namespace</h1> 54<h2>Description</h2> 55 <div class="section"> 56<p>Namespace for the CTR HIO (Host IO) functionality. <br />(This can also be written without the "<CODE>::CTR</CODE>" portion.)</p>Host IO provides three methods of communicating with a PC: files, serial communication, and shared memory. 57 58<H3> Files</H3><P>Files and directories on a PC can be accessed using the <a href="../../../nn/hio/CTR/HostFile/Overview.html"><CODE>nn::hio::CTR::HostFile</CODE></a> and <a href="../../../nn/hio/CTR/HostDirectoryA/Overview.html"><CODE>nn::hio::CTR::HostDirectoryA</CODE></a> classes.</P><P> 59To use the <CODE>HostFile</CODE> class, you must run the <CODE>PARTNER-CTR HIO-Daemon</CODE> on the PC. 60</P><H3> Serial Communication</H3><P>The <a href="../../../nn/hio/CTR/SerialChannel/Overview.html"><CODE>nn::hio::CTR::SerialChannel</CODE></a> class provides a means of bidirectional communication with programs running on the PC. 61 </P><P> 62The PC must be running a program that performs serial communication. 63</P><H3> Shared Memory</H3>The <a href="../../../nn/hio/CTR/SharedMemoryChannel/Overview.html"><CODE>nn::hio::CTR::SharedMemoryChannel</CODE></a> class provides shared memory that can be accessed from both the PC and the CTR system. 64 <P> 65The PC must be running a program that uses Host IO shared memory. 66</P><h3> Using Channels </h3> 67The serial communication and shared memory features of the Host IO library use channels to communicate. You can use multiple channels simultaneously. However, use a single process and a single thread for all channel operations. Serial sending and receiving can be done in separate threads.</div> 68 <a name="class" id="class"> 69<h2>Classes</h2> 70 <div class="section"> 71 <table class="members"> 72 <tr> 73 <th> 74<a href="../../../nn/hio/CTR/HostDirectoryA/Overview.html"><CODE>nn::hio::CTR::HostDirectoryA</CODE></a> 75 </th> 76<td>Class that represents directories in the host file system. It can be used to get information about the entries that belong to directories.</td> 77 </tr> 78 <tr> 79 <th> 80<a href="../../../nn/hio/CTR/HostDirectoryW/Overview.html"><CODE>nn::hio::CTR::HostDirectoryW</CODE></a> 81 </th> 82<td>Unicode version of the <a href="../../../nn/hio/CTR/HostDirectoryA/Overview.html"><CODE>HostDirectoryA</CODE></a> class.</td> 83 </tr> 84 <tr> 85 <th> 86<a href="../../../nn/hio/CTR/HostFile/Overview.html"><CODE>nn::hio::CTR::HostFile</CODE></a> 87 </th> 88<td>Class that represents files in the host file system. It provides the ability to read from and write to files.</td> 89 </tr> 90 <tr> 91 <th> 92<a href="../../../nn/hio/CTR/SerialChannel/Overview.html"><CODE>nn::hio::CTR::SerialChannel</CODE></a> 93 </th> 94<td>Class that represents the channels used for serial communication.</td> 95 </tr> 96 <tr> 97 <th> 98<a href="../../../nn/hio/CTR/SharedMemoryChannel/Overview.html"><CODE>nn::hio::CTR::SharedMemoryChannel</CODE></a> 99 </th> 100<td>Class that represents the channels used for shared memory.</td> 101 </tr> </table> 102 </div> 103 </a> <a name="struct" id="struct"> 104<h2>Structures</h2> 105 <div class="section"> 106 <table class="members"> 107 <tr> 108 <th> 109<a href="../../../nn/hio/CTR/HostSystemTime/Overview.html"><CODE>nn::hio::CTR::HostSystemTime</CODE></a> 110 </th> 111<td>Structure representing time stamps.</td> 112 </tr> 113 <tr> 114 <th> 115<a href="../../../nn/hio/CTR/DirectoryEntryA/Overview.html"><CODE>nn::hio::CTR::DirectoryEntryA</CODE></a> 116 </th> 117<td>Structure representing directory entries.</td> 118 </tr> 119 <tr> 120 <th> 121<a href="../../../nn/hio/CTR/DirectoryEntryW/Overview.html"><CODE>nn::hio::CTR::DirectoryEntryW</CODE></a> 122 </th> 123<td>Unicode version of the <a href="../../../nn/hio/CTR/DirectoryEntryA/Overview.html"><CODE>DirectoryEntryA</CODE></a> class.</td> 124 </tr> </table> 125 </div> 126 </a> <a name="enum" id="enum"> 127<h2>Enumerated Types</h2> 128 <div class="section"> 129 <table class="members"> 130 <tr> 131 <td width="100"> </td> 132 <th> 133<a href="../../../nn/hio/CTR/FileAttribute.html"><CODE>FileAttribute</CODE></a> 134 </th> 135<td>Enumerated type that represents file attributes.</td> 136 </tr> </table> 137 </div> 138 </a> <a name="constant" id="constant"> 139<h2>Constants</h2> 140 <div class="section"> 141 <table class="members"> 142 <tr> 143 <td width="100"> </td> 144 <th> 145<span class="argument"><a href="../../../nn/hio/CTR/WORKMEMORY_SIZE.html"><CODE>WORKMEMORY_SIZE</CODE></a></span> 146 </th> 147<td>Size of the work memory required to open a channel.</td> 148 </tr> 149 <tr> 150 <td width="100"> </td> 151 <th> 152<span class="argument"><a href="../../../nn/hio/CTR/MAX_CHANNEL_NUM.html"><CODE>MAX_CHANNEL_NUM</CODE></a></span> 153 </th> 154<td>Maximum number of channels.</td> 155 </tr> 156 <tr> 157 <td width="100"> </td> 158 <th> 159<span class="argument"><a href="../../../nn/hio/CTR/MAX_PATH.html"><CODE>MAX_PATH</CODE></a></span> 160 </th> 161<td>Represents the maximum allowable path length. This value includes the null terminator at the end of the path.</td> 162 </tr> </table> 163 </div> 164 </a> <a name="function" id="function"> 165<h2>Functions</h2> 166 <div class="section"> 167 <table class="members"> 168 <tr> 169<th class="category" colspan="3">Initialize/Finalize</th> 170 </tr> 171 <tr> 172 <td width="100"> </td> 173 <th> 174<a href="../../../nn/hio/CTR/Initialize.html"><CODE>Initialize</CODE></a> 175 </th> 176<td>Initializes the HIO library. Call this function once before using the library.</td> 177 </tr> 178 <tr> 179 <td width="100"> </td> 180 <th> 181<a href="../../../nn/hio/CTR/Finalize.html"><CODE>Finalize</CODE></a> 182 </th> 183<td>Finalizes the HIO library. Call this function once after using the library.</td> 184 </tr> 185 <tr> 186<th class="category" colspan="3">Other</th> 187 </tr> 188 <tr> 189 <td width="100"> </td> 190 <th> 191<a href="../../../nn/hio/CTR/GetHioDaemonStatus.html"><CODE>GetHioDaemonStatus</CODE></a> 192 </th> 193<td>Gets whether the <CODE>HostIO</CODE> daemon process is running on the host.</td> 194 </tr> 195 <tr> 196 <td width="100"> </td> 197 <th> 198<a href="../../../nn/hio/CTR/GetVersion.html"><CODE>GetVersion</CODE></a> 199 </th> 200<td>Gets the version of the HIO library.</td> 201 </tr> 202 <tr> 203 <td width="100"> </td> 204 <th> 205<a href="../../../nn/hio/CTR/DeleteFile.html"><CODE>DeleteFile</CODE></a> 206 </th> 207<td>Deletes a file.</td> 208 </tr> 209 <tr> 210 <td width="100"> </td> 211 <th> 212<a href="../../../nn/hio/CTR/DeleteDirectory.html"><CODE>DeleteDirectory</CODE></a> 213 </th> 214<td>Deletes a directory. The operation fails if the directory is not empty.</td> 215 </tr> 216 <tr> 217 <td width="100"> </td> 218 <th> 219<a href="../../../nn/hio/CTR/CreateDirectory.html"><CODE>CreateDirectory</CODE></a> 220 </th> 221<td>Creates a directory.</td> 222 </tr> 223 <tr> 224 <td width="100"> </td> 225 <th> 226<a href="../../../nn/hio/CTR/Rename.html"><CODE>Rename</CODE></a> 227 </th> 228<td>Changes filenames and directory names.</td> 229 </tr> 230 <tr> 231 <td width="100"> </td> 232 <th> 233<a href="../../../nn/hio/CTR/GetCurrentDirectory.html"><CODE>GetCurrentDirectory</CODE></a> 234 </th> 235<td>Gets the current directory.</td> 236 </tr> 237 <tr> 238 <td width="100"> </td> 239 <th> 240<a href="../../../nn/hio/CTR/SetCurrentDirectory.html"><CODE>SetCurrentDirectory</CODE></a> 241 </th> 242<td>Sets the current directory.</td> 243 </tr> 244 <tr> 245 <td width="100"> </td> 246 <th> 247<a href="../../../nn/hio/CTR/GetEnvironmentVariable.html"><CODE>GetEnvironmentVariable</CODE></a> 248 </th> 249<td>Gets the value of an environment variable.</td> 250 </tr> 251 <tr> 252 <td width="100"> </td> 253 <th> 254<a href="../../../nn/hio/CTR/ResultNoConnected.html"><CODE>ResultNoConnected</CODE></a> 255 </th> 256<td>Returns a <CODE>Result</CODE> value indicating that there is no connection.</td> 257 </tr> 258 <tr> 259 <td width="100"> </td> 260 <th> 261<a href="../../../nn/hio/CTR/ResultConnected.html"><CODE>ResultConnected</CODE></a> 262 </th> 263<td>Returns a <CODE>Result</CODE> value indicating that the local host is connected.</td> 264 </tr> </table> 265 </div> 266 </a> 267<h2>Revision History</h2> 268 <div class="section"> 269 <dl class="history"> 270 <dt>2010/03/03</dt> 271<dd>Initial version.<br /> 272 </dd> 273 </dl> 274 </div> 275 <hr><p>CONFIDENTIAL</p></body> 276</html>