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::Directory::Read</CODE> Member Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14s32 Read(
15     <a href="../../../nn/fs/DirectoryEntry/Overview.html">DirectoryEntry</a> pEntries[],
16     s32 numEntries
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>out</td>
32<th>pEntries[]</th>
33<td>Location to which to load directory entries.</td>
34        </tr>
35        <tr>
36<td>in</td>
37<th>numEntries</th>
38<td>Maximum number of directory entries to load.</td>
39        </tr> </table>
40    </div>
41<h2>Return Values</h2>
42<div class="section">Returns the number of entries that were actually loaded. Returns <CODE>0</CODE> when it has finished scanning all the entries. </div>
43<h2>Description</h2>
44    <div class="section">
45<p>Loads the specified number of entries from a directory.</p><p>Up to <SPAN class="argument">numEntries</SPAN> entries are read from the current file position and copied to the region at the address specified by <span class="argument">pEntries</span>.</p><p>
46This function is implemented to show an error screen when errors occur internally, whether or not such errors are fatal. Control does not return from the function in this case. Use <CODE><a href="../../../nn/fs/Directory/TryRead.html">nn::fs::Directory::TryRead</a> </CODE> on everything other than ROM archives.
47            </p><p>
48To read details about error handling, see <a href="../briefing/aboutErrorHandling.html#FileAndDirectory">Handling Errors During File and Directory Operations</a>.
49            </p></div>
50<h2>Revision History</h2>
51    <div class="section">
52      <dl class="history">
53        <dt>2010/12/24</dt>
54<dd>Added a link to the error handling page.
55        </dd>
56        <dt>2010/01/29</dt>
57<dd>Initial version.<br />
58        </dd>
59      </dl>
60    </div>
61  <hr><p>CONFIDENTIAL</p></body>
62</html>