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_RewindDir</title>
9<LINK rel="stylesheet" href="../../css/nitro.css" type="text/css">
10</head>
11
12<body>
13
14<h1 align="left">FS_RewindDir <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_RewindDir( <A href="../fs_file_type.html">FSFile</a> *p_dir );</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%"><EM><STRONG>p_dir</STRONG></EM></TD>
30      <TD width="87%">Address of the <A href="../fs_file_type.html"><CODE>FSFile</CODE></A> structure.</TD>
31    </TR>
32  </TBODY>
33</TABLE>
34
35<h2>Return Values</h2>
36<p>Returns TRUE if the directory list correctly returns to the beginning; FALSE otherwise.</p>
37
38<H2>Description</H2>
39<P>This function returns the list position that is currently maintained in the specified directory list. This function is equivalent to prestoring the value of <code><A href="../fs_dir_pos_type.html">FSDirPos</a></code> that indicates the beginning position and using that when calling the <code><a href="FS_SeekDir.html">FS_SeekDir</a></code> function. <BR>
40<H2>Note</H2>
41<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>
42<BR>
43<h2>See Also</h2>
44<p><A href="../fs_file_type.html"><code>FSFile</code></A>, <A href="../fs_dir_pos_type.html"><code>FSDirPos</code></A>, <A href="FS_SeekDir.html"><code>FS_SeekDir</code></A>, <A href="FS_TellDir.html"><code>FS_TellDir</code></A></p>
45
46<H2>Revision History</H2>
47<P>
482004/09/24 Added the description in the Caution section 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.<BR>
49</P>
50<hr><p>CONFIDENTIAL</p></body>
51</html>
52