1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html>
3
4<head>
5<META http-equiv="Content-Type" content="text/html; charset=windows-1252">
6<META name="GENERATOR" content="IBM WebSphere Studio Homepage Builder Version 7.0.0.0 for Windows">
7<META http-equiv="Content-Style-Type" content="text/css">
8<title>FS_ReadDir</title>
9<LINK rel="stylesheet" href="../../css/nitro.css" type="text/css">
10</head>
11
12<body>
13
14<h1 align="left">FS_ReadDir<img src="../../image/NTR.gif"align="middle"><img src="../../image/TWL.gif" align="middle"></h1>
15<h2>Syntax</h2>
16
17<dl>
18  <dd>
19<CODE>#include &lt;nitro/fs.h&gt;</CODE><BR>
20  <BR>
21  <CODE>BOOL FS_ReadDir( FSFile *p_dir, FSDirEntry *p_entry );</CODE><br>
22  <br>
23  </dd>
24</dl>
25<h2>Arguments</h2>
26<TABLE border="1" width="100%">
27  <TBODY>
28    <TR>
29<TD width="13%"><SPAN class="argument">p_dir</SPAN></TD>
30<TD width="87%">Address of the <a href="../fs_file_type.html"><CODE>FSFile</CODE></a> structure.</TD>
31    </TR>
32    <TR>
33<TD width="13%"><SPAN class="argument">p_entry</SPAN></TD>
34<TD width="87%">Address of the <CODE>FSDirEntry</CODE> structure.</TD>
35    </TR>
36  </TBODY>
37</TABLE>
38
39<h2>Return Values</h2>
40<p>If there is a remaining directory entry, this function gets the remaining directory entry and returns <CODE>TRUE</CODE>.<BR>If this function arrives at the end of the directory list, it returns <CODE>FALSE</CODE>.</p>
41
42<H2>Description</H2>
43<P>Gets the next directory entry from the specified directory list. Each time the next directory entry is acquired, the directory list position is incremented by one. When the directory list arrives at the end, this function returns <CODE>FALSE</CODE> starting with the next call. <BR> For example, if you use the <A href="FS_FindDir.html"><CODE>FS_FindDir</CODE></A> function to open a directory containing three files and then call that directory using this function, this function returns <CODE>TRUE</CODE> three times and <CODE>FALSE</CODE> the fourth time.<BR></p>
44<p>Use the <a href="../directory/FS_ReadDirectory.html"><CODE>FS_ReadDirectory</CODE></a> function to get detailed information such as update times and file attributes such as <a href="../overview/about_Archive.html#NAND">NAND Archives</a> and <a href="../overview/about_Archive.html#SDMC">SD memory card Archives</a>.
45</p>
46<H2>Note</H2>
47<p><font color="#800000">This function cannot be called from the interrupt handler (IRQ mode).<br> Also note that in some cases processing may not end if interrupts are left prohibited.<br></font></p>
48<BR>
49<h2>See Also</h2>
50<p><A href="../fs_file_type.html"><CODE>FSFile</CODE></A><BR> <A href="../fs_dir_entry_type.html"><CODE>FSDirEntry</CODE></A><BR> <A href="FS_FindDir.html"><CODE>FS_FindDir</CODE></A><BR> <A href="FS_TellDir.html"><CODE>FS_TellDir</CODE></A><BR> <A href="FS_SeekDir.html"><CODE>FS_SeekDir</CODE></A><BR> <A href="FS_RewindDir.html"><CODE>FS_RewindDir</CODE></A><BR> <a href="../directory/FS_ReadDirectory.html"><CODE>FS_ReadDirectory</CODE></a></p>
51
52<H2>Revision History</H2>
53<P>
542009/07/16 Added description of explanation related to <CODE>FS_ReadDirectory</CODE>.<br> 2009/07/16 Updated part of <B>See Also</B>.<BR> 2004/09/24 Added the description in <B>Note</B> regarding the conditions for calling this function.<br> 2004/04/08 Revised description due to the integration of <CODE>FSDir</CODE> and <CODE>FSFile</CODE>.<br> 2004/04/01 Initial version.
55</P>
56<hr><p>CONFIDENTIAL</p></body>
57</html>
58