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_OpenFile</title>
9<LINK rel="stylesheet" href="../../css/nitro.css" type="text/css">
10</head>
11
12<body>
13
14<h1 align="left">FS_OpenFile<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_OpenFile(FSFile *file, const char *path);</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">file</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">path</SPAN></TD>
34<TD width="87%">Path name of file.</TD>
35    </TR>
36  </TBODY>
37</TABLE>
38
39<h2>Return Values</h2>
40<p>Returns <CODE>TRUE</CODE> if the file opens properly; <CODE>FALSE</CODE> otherwise.</p>
41
42<H2>Description</H2>
43<P>This function is the same as <CODE><a href="FS_OpenFileEx.html">FS_OpenFileEx</a>(file, path, <a href="../FS_FILEMODE.html">FS_FILEMODE_R</a>)</CODE>.<br />It was created for the sake of compatibility, but now we recommend that you use <a href="FS_OpenFileEx.html"><CODE>FS_OpenFileEx</CODE></a>.
44</P>
45
46<h2>Note</h2>
47<p style='color:Red;'>The structures of opened files are associated with system resources so you cannot move or duplicate information even by copying them to other structures as they are. For details, see <a href="../fs_file_type.html"><CODE>FSFile</CODE> structure</a>.</p>
48
49<h2>See Also</h2>
50<p><a href="FS_OpenFileEx.html"><CODE>FS_OpenFileEx</CODE></a></p>
51
52<H2>Revision History</H2>
53<P>
542009/07/14 Added mention that copying the values of the structure is not guaranteed.<br /> 2007/09/18 Changed the description so that use of <CODE>FS_OpenFileEx</CODE> is recommended.<br /> 2004/09/24 Added description in <B>Note</B> regarding the conditions for calling this function.<br /> 2004/04/02 Revised <B>Description</B> due to elimination of path length restriction.<br /> 2004/04/01 Initial version.
55</P>
56<hr><p>CONFIDENTIAL</p></body>
57</html>
58