1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html xmlns="http://www.w3.org/1999/xhtml">
3<head>
4<meta http-equiv="Content-Type" content="text/html; charset=windows-1252" />
5<meta http-equiv="Content-Style-Type" content="text/css" />
6<title>FS_OpenTopLevelDirectory</title>
7<link rel="stylesheet" href="../../css/nitro.css" type="text/css" />
8</head>
9<body>
10
11<h1>FS_OpenTopLevelDirectory <img src="../../image/NTR.gif"align="middle"><img src="../../image/TWL.gif" align="middle"></h1>
12<h2>Syntax</h2>
13<pre><code>
14#include &lt;nitro/fs.h&gt;
15
16BOOL FS_OpenTopLevelDirectory(<a href="../fs_file_type.html">FSFile</a> *dir);
17</code></pre>
18
19<h2>Arguments</h2>
20<table style="width:100%">
21<tbody>
22<tr>
23<td style="width:13%"><SPAN class="argument">dir</SPAN></td>
24<td style="width:87%"><CODE>FSFile</CODE> structure where the handle is stored</td>
25</tr>
26</tbody>
27</table>
28
29<h2>Return Values</h2>
30<p>This function always succeeds and returns <CODE>TRUE</CODE>.</p>
31
32<h2>Description</h2>
33<p>Opens the top-level directory that contains a list of the usable archive names.<br />If you call the <a href="FS_ReadDirectory.html"><code>FS_ReadDirectory</code></a> function for the directory handler retrieved with this function, the archives that are currently mounted into the program are returned one at a time. The name of the mounted archive has a colon appended (for example, <I>rom:</I>).</p>
34
35<h2>Notes</h2>
36<ul>
37<li>This function cannot be called from the interrupt handler (IRQ mode). Also note that in some cases processing may not end if interrupts are disabled.</li>
38<li style='color:Red;'>Because the structures of opened files are linked with system resources, you cannot move or duplicate the information in these structures by copying them into other structures. For details, see the <a href="../fs_file_type.html"><CODE>FSFile</CODE></a> structure.</li>
39</ul>
40
41<h2>See Also</h2>
42<p><a href="../fs_file_type.html"><CODE>FSFile</CODE></a><br /> <a href="FS_ReadDirectory.html"><CODE>FS_ReadDirectory</CODE></a><br /> <a href="FS_CloseDirectory.html"><CODE>FS_CloseDirectory</CODE></a></p>
43
44<h2>Revision History</h2>
45<p>
462009/07/29 Added mention that copying structure values is not guaranteed.<br />
47 2008/12/04 Initial version.</p>
48<hr><p>CONFIDENTIAL</p></body>
49</html>
50