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>TryRead</title>
8  </head>
9  <body>
10<h1><CODE><a href="../../../nn/Overview.html">nn</a>::<a href="../../../nn/fs/Overview.html">fs</a>::<a href="../../../nn/fs/FileInputStream/Overview.html">FileInputStream</a>::TryRead</CODE> Member Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14virtual <a href="../../../nn/Result/Overview.html">Result</a> TryRead(
15     <a href="../../../nn_types/s32.html">s32</a> * pOut,
16     void * buffer,
17     size_t size
18);
19</pre>
20    </div>
21<h2>Parameters</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>out</td>
33<th>pOut</th>
34<td>Stores the size of data (in bytes) that were actually copied. The value <CODE>0</CODE> is stored if the function reaches the end of the file.</td>
35        </tr>
36        <tr>
37<td>in</td>
38<th>buffer</th>
39<td>Pointer to the buffer where the data will be copied.</td>
40        </tr>
41        <tr>
42<td>in</td>
43<th>size</th>
44<td>Maximum number of bytes to copy.</td>
45        </tr> </table>
46    </div>
47<h2>Return Values</h2>
48<div class="section">Returns the result of the operation. </div>
49<h2>Description</h2>
50    <div class="section">
51<p>Reads 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>Do not access the memory of the specified buffer region (neither reading nor writing) during this function call (for example, from another thread). File reads may be incorrect, and the program could stop working in a future version of the SDK.</p><p>
52Error handling will differ, depending on the archive. For details, see <a href="../briefing/aboutErrorHandling.html#FileAndDirectory">Handling Errors During File and Directory Operations</a>.
53            </p></div>
54<h2>Revision History</h2>
55    <div class="section">
56      <dl class="history">
57        <dt>2011/03/18</dt>
58<dd>Added note about limitations on buffer access during function call.<br />
59        </dd>
60        <dt>2010/12/22</dt>
61<dd>Added a link to the error handling page.
62        </dd>
63        <dt>2010/06/14</dt>
64<dd>Initial version.<br />
65        </dd>
66      </dl>
67    </div>
68  <hr><p>CONFIDENTIAL</p></body>
69</html>
70