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>nn::fs::FileStream::Read</CODE> Member Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14virtual s32 Read(
15     void * buffer,
16     size_t size
17);
18</pre>
19    </div>
20<h2>Arguments</h2>
21    <div class="section">
22      <table class="arguments">
23        <thead>
24          <tr>
25            <td width="15" />
26<th>Name</th>
27<td>Description</td>
28          </tr>
29        </thead>
30        <tr>
31<td>in</td>
32<th>buffer</th>
33<td>Pointer to the buffer where the data will be copied.</td>
34        </tr>
35        <tr>
36<td>in</td>
37<th>size</th>
38<td>Maximum number of bytes to copy.</td>
39        </tr> </table>
40    </div>
41<h2>Return Values</h2>
42<div class="section">Returns the size of data (in bytes) that were actually copied. Returns 0 if it reached the end of the file. </div>
43<h2>Description</h2>
44    <div class="section">
45<p>Loads the specified amount of data from a file into a buffer.</p><p>Up to <SPAN class="argument">size</SPAN> bytes of data are read from the current file position and copied to the region at the address specified by <SPAN class="argument">buffer</SPAN>.</p><p>This function does not return processing results and it is therefore impossible to handle errors. In general, use <a href="../../../nn/fs/FileStream/TryRead.html"><CODE>TryRead</CODE></a>.</p><!-- write here --></div>
46<h2>Revision History</h2>
47    <div class="section">
48      <dl class="history">
49        <dt>2010/01/29</dt>
50<dd>Initial version.<br />
51        </dd>
52      </dl>
53    </div>
54  <hr><p>CONFIDENTIAL</p></body>
55</html>