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<title>Read</title>
8  </head>
9  <body>
10<h1><CODE><a href="../../../../nn/Overview.html">nn</a>::<a href="../../../../nn/hio/Overview.html">hio</a>::<a href="../../../../nn/hio/CTR/Overview.html">CTR</a>::<a href="../../../../nn/hio/CTR/HostFile/Overview.html">HostFile</a>::Read</CODE> Member Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">#include &lt;nn/hio.h&gt;
14
15<a href="../../../../nn_types/s32.html">s32</a> Read(
16     void * buf,
17     size_t size
18);
19</pre>
20    </div>
21<h2>Arguments</h2>
22    <div class="section">
23      <table class="arguments">
24        <thead>
25          <tr>
26            <td width="15" />
27<th>Name</th>
28<td>Description</td>
29          </tr>
30        </thead>
31        <tr>
32<td>in</td>
33<th>buf</th>
34<td>Pointer to the buffer where the data is read into.</td>
35        </tr>
36        <tr>
37<td>in</td>
38<th>size</th>
39<td>Maximum number of bytes to read.</td>
40        </tr> </table>
41    </div>
42<h2>Return Values</h2>
43<div class="section">Returns the actual number of bytes that were copied. If an error occurred, it returns <CODE>-1</CODE>. </div>
44<h2>Description</h2>
45    <div class="section">
46<p>Reads the specified amount of data from a file into a buffer, and returns the size of data (in bytes) that were actually read.</p><p>Up to <B>size</B> bytes of data are read from the current file position and copied to the region at the address specified by <B>buf</B>.<br />Returns the number of bytes that were copied.</p>In the debugger environment, the portion in the read buffer after the returned position is undefined.<br />If there is a difference between the requested size and the read size, do not treat the values beyond the read size as if they were unmodified initialized values.</div>
47<h2>Revision History</h2>
48    <div class="section">
49      <dl class="history">
50        <dt>2010/06/21</dt>
51<dd>Added specification and note.<br />
52        </dd>
53        <dt>2010/06/14</dt>
54<dd>Added description of arguments and behavior.<br />
55        </dd>
56        <dt>2010/03/31</dt>
57<dd>Initial version.<br />
58        </dd>
59      </dl>
60    </div>
61  <hr><p>CONFIDENTIAL</p></body>
62</html>
63