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_GetPathInfo</title>
7<link rel="stylesheet" href="../../css/nitro.css" type="text/css" />
8</head>
9<body>
10
11<h1>FS_GetPathInfo <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_GetPathInfo(const char *path, <a href="../FSPathInfo.html">FSPathInfo</a> *info);
17</code></pre>
18
19<h2>Arguments</h2>
20<table style="width:100%">
21<tbody>
22<tr>
23<td style="width:13%"><CODE>path</CODE></td>
24<td style="width:87%">Path name of the file or directory that you want to get information about.</td>
25</tr>
26<tr>
27<td style="width:13%"><CODE>info</CODE></td>
28<td style="width:87%">Pointer to the <code><a href="../FSPathInfo.html">FSPathInfo</a></code> structure where the obtained data should be stored.</td>
29</tr>
30</tbody>
31</table>
32
33<h2>Return Values</h2>
34<p>Returns TRUE if the entry information for the specified path was obtained properly; returns FALSE otherwise. In case of failure, the error details can be obtained using <code><a href="../archive/FS_GetArchiveResultCode.html">FS_GetArchiveResultCode()</a></code>.</p>
35
36<h2>Description</h2>
37<p>Gets the entry information for the specified file or directory. If there is a file or directory at the specified path, this function gets the entry information and returns TRUE. <br />The function fails and returns FALSE in the following situations:
38</p>
39<ul>
40<li>When there is no file or directory at the specified path</li>
41</ul>
42<p>The entry information for TWL-only files is available even when the system is operating in NITRO mode. You can determine whether access to the file is actually possible by checking the <a href="../FSPathInfo.html">FS_ATTRIBUTE_IS_OFFLINE</a> flag of the <a href="../FSPathInfo.html">attributes</a> field. (For more information on the specification of TWL-only files, see the explanation about the <CODE>Put</CODE> parameter in <a href="../../tools/makerom.html">makerom.TWL</a>.)</p>
43
44<h2>Note</h2>
45<ul>
46<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 left prohibited.</li>
47</ul>
48
49<h2>See Also</h2>
50<p><code><a href="../FSPathInfo.html">FSPathInfo</a> <br /> <a href="../archive/FS_GetArchiveResultCode.html">FS_GetArchiveResultCode</a></code></p>
51
52<h2>Revision History</h2>
53<p>
542009/01/08 Added an explanation about TWL-only files.<br />2007/12/13 Initial version.<br />
55</p>
56<hr><p>CONFIDENTIAL</p></body>
57</html>
58