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/Result/Overview.html">Result</a> Read(
16     size_t * pRead,
17     void * buf,
18     size_t size
19);
20</pre>
21    </div>
22<h2>Parameters</h2>
23    <div class="section">
24      <table class="arguments">
25        <thead>
26          <tr>
27            <td width="15" />
28<th>Name</th>
29<td>Description</td>
30          </tr>
31        </thead>
32        <tr>
33<td>out</td>
34<th>pRead</th>
35<td>Stores the actual number of bytes that were copied. If the end of the file is reached, it stores the value <CODE>0</CODE>.</td>
36        </tr>
37        <tr>
38<td>in</td>
39<th>buf</th>
40<td>Pointer to the buffer where the data is read into.</td>
41        </tr>
42        <tr>
43<td>in</td>
44<th>size</th>
45<td>Maximum number of bytes to read.</td>
46        </tr> </table>
47    </div>
48<h2>Return Values</h2>
49<div class="section">Returns the result of the operation. </div>
50<h2>Description</h2>
51    <div class="section">
52<p>Reads the specified amount of data from a file into a buffer, and returns the result of the operation.</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 />The function stores the number of copied bytes in <B>pRead</B> and returns a <CODE><a href="../../../../nn/Result/Overview.html">nn::Result</a></CODE>-type process result.</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>
53<h2>Revision History</h2>
54    <div class="section">
55      <dl class="history">
56        <dt>2010/06/21</dt>
57<dd>Added specification and note.<br />
58        </dd>
59        <dt>2010/06/14</dt>
60<dd>Added description of arguments and behavior.<br />
61        </dd>
62        <dt>2010/03/31</dt>
63<dd>Initial version.<br />
64        </dd>
65      </dl>
66    </div>
67  <hr><p>CONFIDENTIAL</p></body>
68</html>