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><a href="../../../nn/Overview.html">nn</a>::<a href="../../../nn/hio/Overview.html">hio</a>::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>
137          <tr>
138            <td width="100"> </td>
139            <th>
140<a href="../../../nn/hio/CTR/ResultDescription.html"><CODE>ResultDescription</CODE></a>
141            </th>
142<td>Displays error details.</td>
143          </tr> </table>
144      </div>
145    </a> <a name="constant" id="constant">
146<h2>Constants</h2>
147      <div class="section">
148        <table class="members">
149          <tr>
150            <td width="100"> </td>
151            <th>
152<span class="argument"><a href="../../../nn/hio/CTR/WORKMEMORY_SIZE.html"><CODE>WORKMEMORY_SIZE</CODE></a></span>
153            </th>
154<td width="100">const size_t</td>
155<td>Size of the work memory required to open a channel.</td>
156          </tr>
157          <tr>
158            <td width="100"> </td>
159            <th>
160<span class="argument"><a href="../../../nn/hio/CTR/MAX_CHANNEL_NUM.html"><CODE>MAX_CHANNEL_NUM</CODE></a></span>
161            </th>
162<td width="100">const size_t</td>
163<td>Maximum number of channels.</td>
164          </tr>
165          <tr>
166            <td width="100"> </td>
167            <th>
168<span class="argument"><a href="../../../nn/hio/CTR/MAX_PATH.html"><CODE>MAX_PATH</CODE></a></span>
169            </th>
170<td width="100">const int</td>
171<td>Represents the maximum allowable path length. This value includes the null terminator at the end of the path.</td>
172          </tr> </table>
173      </div>
174    </a> <a name="function" id="function">
175<h2>Functions</h2>
176      <div class="section">
177        <table class="members">
178          <tr>
179<th class="category" colspan="3">Initialize/Finalize</th>
180          </tr>
181          <tr>
182            <td width="100">  </td>
183            <th>
184<a href="../../../nn/hio/CTR/Initialize.html"><CODE>Initialize</CODE></a>
185            </th>
186<td>Initializes the HIO library. Call this function once before using the library.</td>
187          </tr>
188          <tr>
189            <td width="100">  </td>
190            <th>
191<a href="../../../nn/hio/CTR/Finalize.html"><CODE>Finalize</CODE></a>
192            </th>
193<td>Finalizes the HIO library. Call this function once after using the library.</td>
194          </tr>
195          <tr>
196<th class="category" colspan="3">Other</th>
197          </tr>
198          <tr>
199            <td width="100">  </td>
200            <th>
201<a href="../../../nn/hio/CTR/GetHioDaemonStatus.html"><CODE>GetHioDaemonStatus</CODE></a>
202            </th>
203<td>Gets whether the <CODE>HostIO</CODE> daemon process is running on the host.</td>
204          </tr>
205          <tr>
206            <td width="100">  </td>
207            <th>
208<a href="../../../nn/hio/CTR/GetVersion.html"><CODE>GetVersion</CODE></a>
209            </th>
210<td>Gets the version of the HIO library.</td>
211          </tr>
212          <tr>
213            <td width="100">  </td>
214            <th>
215<a href="../../../nn/hio/CTR/DeleteFile.html"><CODE>DeleteFile</CODE></a>
216            </th>
217<td>Deletes file and returns the result of the process.</td>
218          </tr>
219          <tr>
220            <td width="100">  </td>
221            <th>
222<a href="../../../nn/hio/CTR/DeleteDirectory.html"><CODE>DeleteDirectory</CODE></a>
223            </th>
224<td>Deletes directory and returns the result of the process.</td>
225          </tr>
226          <tr>
227            <td width="100">  </td>
228            <th>
229<a href="../../../nn/hio/CTR/CreateDirectory.html"><CODE>CreateDirectory</CODE></a>
230            </th>
231<td>Creates directory and returns the result of the process.</td>
232          </tr>
233          <tr>
234            <td width="100">  </td>
235            <th>
236<a href="../../../nn/hio/CTR/Rename.html"><CODE>Rename</CODE></a>
237            </th>
238<td>Changes file/directory name and returns the result of the process.</td>
239          </tr>
240          <tr>
241            <td width="100">  </td>
242            <th>
243<a href="../../../nn/hio/CTR/GetCurrentDirectory.html"><CODE>GetCurrentDirectory</CODE></a>
244            </th>
245<td>Gets the current directory and returns the result of the process.</td>
246          </tr>
247          <tr>
248            <td width="100">  </td>
249            <th>
250<a href="../../../nn/hio/CTR/SetCurrentDirectory.html"><CODE>SetCurrentDirectory</CODE></a>
251            </th>
252<td>Sets the current directory and returns the result of the process.</td>
253          </tr>
254          <tr>
255            <td width="100">  </td>
256            <th>
257<a href="../../../nn/hio/CTR/GetEnvironmentVariable.html"><CODE>GetEnvironmentVariable</CODE></a>
258            </th>
259<td>Gets the environment variable and returns the result of the process.</td>
260          </tr>
261          <tr>
262            <td width="100">  </td>
263            <th>
264<a href="../../../nn/hio/CTR/ResultNoConnected.html"><CODE>ResultNoConnected</CODE></a>
265            </th>
266<td>Returns a <CODE>Result</CODE> value indicating that there is no connection.</td>
267          </tr>
268          <tr>
269            <td width="100">  </td>
270            <th>
271<a href="../../../nn/hio/CTR/ResultConnected.html"><CODE>ResultConnected</CODE></a>
272            </th>
273<td>Returns a <CODE>Result</CODE> value indicating that the local host is connected.</td>
274          </tr> </table>
275      </div>
276    </a>
277<h2>Revision History</h2>
278    <div class="section">
279      <dl class="history">
280        <dt>2010/06/14</dt>
281<dd>Added descriptions of the various functions.<br />
282        </dd>
283        <dt>2010/03/03</dt>
284<dd>Initial version.<br />
285        </dd>
286      </dl>
287    </div>
288  <hr><p>CONFIDENTIAL</p></body>
289</html>