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<a href="../../../../nn/Result/Overview.html">Result</a> Read(
15     size_t * pRead,
16     void * buf,
17     size_t size
18);
19s32 Read(
20     void * buf,
21     size_t size
22);
23</pre>
24    </div>
25<h2>List of Overloaded Member Functions</h2>
26    <div class="section">
27      <table class="members">
28        <tr>
29          <td>
30<a href="./Read(0).html"><CODE>Read(size_t *, void *, size_t)</CODE> </a>
31          </td>
32<td>Reads the specified amount of data from a file into a buffer, and returns the result of the operation.</td>
33        </tr>
34        <tr>
35          <td>
36<a href="./Read(1).html"><CODE>Read(void *, size_t)</CODE> </a>
37          </td>
38<td>Reads the specified amount of data from a file into a buffer, and returns the size of data (in bytes) that were actually read.</td>
39        </tr> </table>
40    </div>
41<h2>Description of <CODE>Read(size_t *, void *, size_t)</CODE></h2>
42<div class="section"><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>
43<h2>Description of <CODE>Read(void *, size_t)</CODE></h2>
44<div class="section"><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>
45  <hr><p>CONFIDENTIAL</p></body>
46</html>
47