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      span.virtual_style
22      {
23        font-size			 : 8pt;
24        color				 : white;
25        font-weight			: bold;
26        background			: #0a0;
27        border-left			: solid 1px #0f0;
28        border-top			: solid 1px #0f0;
29        border-right		: solid 1px #060;
30        border-bottom		: solid 1px #060;
31        padding-left		: 2px;
32        padding-right		: 2px;
33      }
34      span.protected_style
35      {
36        font-size			 : 8pt;
37        color				 : white;
38        font-weight			: bold;
39        background			: #444;
40        border-left			: solid 1px #ccc;
41        border-top			: solid 1px #ccc;
42        border-right		: solid 1px #222;
43        border-bottom		: solid 1px #222;
44        padding-left		: 2px;
45        padding-right		: 2px;
46      }
47        --></style>
48<title>nn::hio::CTR</title>
49  </head>
50  <body>
51<h1><CODE><a href="../../../nn/Overview.html">nn</a>::<a href="../../../nn/hio/Overview.html">hio</a>::CTR</CODE> Namespace</h1>
52<h2>Description</h2>
53    <div class="section">
54<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.
55
56<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>
57To use the <CODE>HostFile</CODE> class, you must run the <CODE>PARTNER-CTR HIO-Daemon</CODE> on the PC.
58</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.
59            </P><P>
60The PC must be running a program that performs serial communication.
61</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.
62            <P>
63The PC must be running a program that uses Host IO shared memory.
64</P><h3> Using Channels </h3>
65The 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>
66    <a name="class" id="class">
67<h2>Classes</h2>
68      <div class="section">
69        <table class="members">
70          <tr>
71            <th>
72<a href="../../../nn/hio/CTR/HostDirectoryA/Overview.html"><CODE>nn::hio::CTR::HostDirectoryA</CODE></a>
73            </th>
74<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>
75          </tr>
76          <tr>
77            <th>
78<a href="../../../nn/hio/CTR/HostDirectoryW/Overview.html"><CODE>nn::hio::CTR::HostDirectoryW</CODE></a>
79            </th>
80<td>Unicode version of the <a href="../../../nn/hio/CTR/HostDirectoryA/Overview.html"><CODE>HostDirectoryA</CODE></a> class.</td>
81          </tr>
82          <tr>
83            <th>
84<a href="../../../nn/hio/CTR/HostFile/Overview.html"><CODE>nn::hio::CTR::HostFile</CODE></a>
85            </th>
86<td>Class that represents files in the host file system. It provides the ability to read from and write to files.</td>
87          </tr>
88          <tr>
89            <th>
90<a href="../../../nn/hio/CTR/SerialChannel/Overview.html"><CODE>nn::hio::CTR::SerialChannel</CODE></a>
91            </th>
92<td>Class that represents the channels used for serial communication.</td>
93          </tr>
94          <tr>
95            <th>
96<a href="../../../nn/hio/CTR/SharedMemoryChannel/Overview.html"><CODE>nn::hio::CTR::SharedMemoryChannel</CODE></a>
97            </th>
98<td>Class that represents the channels used for shared memory.</td>
99          </tr> </table>
100      </div>
101    </a> <a name="struct" id="struct">
102<h2>Structures</h2>
103      <div class="section">
104        <table class="members">
105          <tr>
106            <th>
107<a href="../../../nn/hio/CTR/HostSystemTime/Overview.html"><CODE>nn::hio::CTR::HostSystemTime</CODE></a>
108            </th>
109<td>Structure representing time stamps.</td>
110          </tr>
111          <tr>
112            <th>
113<a href="../../../nn/hio/CTR/DirectoryEntryA/Overview.html"><CODE>nn::hio::CTR::DirectoryEntryA</CODE></a>
114            </th>
115<td>Structure representing directory entries.</td>
116          </tr>
117          <tr>
118            <th>
119<a href="../../../nn/hio/CTR/DirectoryEntryW/Overview.html"><CODE>nn::hio::CTR::DirectoryEntryW</CODE></a>
120            </th>
121<td>Unicode version of the <a href="../../../nn/hio/CTR/DirectoryEntryA/Overview.html"><CODE>DirectoryEntryA</CODE></a> class.</td>
122          </tr> </table>
123      </div>
124    </a> <a name="enum" id="enum">
125<h2>Enumerated Types</h2>
126      <div class="section">
127        <table class="members">
128          <tr>
129            <td width="100"> </td>
130            <th>
131<a href="../../../nn/hio/CTR/FileAttribute.html"><CODE>FileAttribute</CODE></a>
132            </th>
133<td>Enumerated type that represents file attributes.</td>
134          </tr> </table>
135      </div>
136    </a> <a name="constant" id="constant">
137<h2>Constants</h2>
138      <div class="section">
139        <table class="members">
140          <tr>
141            <td width="100"> </td>
142            <th>
143<span class="argument"><a href="../../../nn/hio/CTR/WORKMEMORY_SIZE.html"><CODE>WORKMEMORY_SIZE</CODE></a></span>
144            </th>
145<td width="100">const size_t</td>
146<td>Size of the work memory required to open a channel.</td>
147          </tr>
148          <tr>
149            <td width="100"> </td>
150            <th>
151<span class="argument"><a href="../../../nn/hio/CTR/MAX_CHANNEL_NUM.html"><CODE>MAX_CHANNEL_NUM</CODE></a></span>
152            </th>
153<td width="100">const size_t</td>
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 width="100">const int</td>
162<td>Represents the maximum allowable path length. This value includes the null terminator at the end of the path.</td>
163          </tr> </table>
164      </div>
165    </a> <a name="function" id="function">
166<h2>Functions</h2>
167      <div class="section">
168        <table class="members">
169          <tr>
170<th class="category" colspan="3">Initialize/Finalize</th>
171          </tr>
172          <tr>
173            <td width="100">  </td>
174            <th>
175<a href="../../../nn/hio/CTR/Initialize.html"><CODE>Initialize</CODE></a>
176            </th>
177<td>Initializes the HIO library. Call this function once before using the library.</td>
178          </tr>
179          <tr>
180            <td width="100">  </td>
181            <th>
182<a href="../../../nn/hio/CTR/Finalize.html"><CODE>Finalize</CODE></a>
183            </th>
184<td>Finalizes the HIO library. Call this function once after using the library.</td>
185          </tr>
186          <tr>
187<th class="category" colspan="3">Other</th>
188          </tr>
189          <tr>
190            <td width="100">  </td>
191            <th>
192<a href="../../../nn/hio/CTR/GetHioDaemonStatus.html"><CODE>GetHioDaemonStatus</CODE></a>
193            </th>
194<td>Gets whether the <CODE>HostIO</CODE> daemon process is running on the host.</td>
195          </tr>
196          <tr>
197            <td width="100">  </td>
198            <th>
199<a href="../../../nn/hio/CTR/GetVersion.html"><CODE>GetVersion</CODE></a>
200            </th>
201<td>Gets the version of the HIO library.</td>
202          </tr>
203          <tr>
204            <td width="100">  </td>
205            <th>
206<a href="../../../nn/hio/CTR/DeleteFile.html"><CODE>DeleteFile</CODE></a>
207            </th>
208<td>Deletes file and returns the result of the process.</td>
209          </tr>
210          <tr>
211            <td width="100">  </td>
212            <th>
213<a href="../../../nn/hio/CTR/DeleteDirectory.html"><CODE>DeleteDirectory</CODE></a>
214            </th>
215<td>Deletes directory and returns the result of the process.</td>
216          </tr>
217          <tr>
218            <td width="100">  </td>
219            <th>
220<a href="../../../nn/hio/CTR/CreateDirectory.html"><CODE>CreateDirectory</CODE></a>
221            </th>
222<td>Creates directory and returns the result of the process.</td>
223          </tr>
224          <tr>
225            <td width="100">  </td>
226            <th>
227<a href="../../../nn/hio/CTR/Rename.html"><CODE>Rename</CODE></a>
228            </th>
229<td>Changes file/directory name and returns the result of the process.</td>
230          </tr>
231          <tr>
232            <td width="100">  </td>
233            <th>
234<a href="../../../nn/hio/CTR/GetCurrentDirectory.html"><CODE>GetCurrentDirectory</CODE></a>
235            </th>
236<td>Gets the current directory and returns the result of the process.</td>
237          </tr>
238          <tr>
239            <td width="100">  </td>
240            <th>
241<a href="../../../nn/hio/CTR/SetCurrentDirectory.html"><CODE>SetCurrentDirectory</CODE></a>
242            </th>
243<td>Sets the current directory and returns the result of the process.</td>
244          </tr>
245          <tr>
246            <td width="100">  </td>
247            <th>
248<a href="../../../nn/hio/CTR/GetEnvironmentVariable.html"><CODE>GetEnvironmentVariable</CODE></a>
249            </th>
250<td>Gets the environment variable and returns the result of the process.</td>
251          </tr>
252          <tr>
253            <td width="100">  </td>
254            <th>
255<a href="../../../nn/hio/CTR/ResultNoConnected.html"><CODE>ResultNoConnected</CODE></a>
256            </th>
257<td>Returns a <CODE>Result</CODE> value indicating that there is no connection.</td>
258          </tr>
259          <tr>
260            <td width="100">  </td>
261            <th>
262<a href="../../../nn/hio/CTR/ResultConnected.html"><CODE>ResultConnected</CODE></a>
263            </th>
264<td>Returns a <CODE>Result</CODE> value indicating that the local host is connected.</td>
265          </tr> </table>
266      </div>
267    </a>
268<h2>Revision History</h2>
269    <div class="section">
270      <dl class="history">
271        <dt>2010/06/14</dt>
272<dd>Added descriptions of the various functions.<br />
273        </dd>
274        <dt>2010/03/03</dt>
275<dd>Initial version.<br />
276        </dd>
277      </dl>
278    </div>
279  <hr><p>CONFIDENTIAL</p></body>
280</html>
281