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_GetArchiveResource</title>
7<link rel="stylesheet" href="../../css/nitro.css" type="text/css" />
8</head>
9<body>
10<h1>FS_GetArchiveResource <img src="../../image/NTR.gif"align="middle"><img src="../../image/TWL.gif" align="middle"></h1>
11<h2>Syntax</h2>
12
13<pre><code>
14#include &lt;nitro/fs.h&gt;
15
16BOOL FS_GetArchiveResource(const char *path, <a href="../FSArchiveResource.html">FSArchiveResource</a> *resource);
17</code></pre>
18<h2>Arguments</h2>
19<table style="width:100%">
20<tbody>
21<tr>
22<td style="width:13%"><CODE>path</CODE></td>
23<td style="width:87%">Path name that specifies an archive.</td>
24</tr>
25<tr>
26<td style="width:13%"><CODE>resource</CODE></td>
27<td style="width:87%"><a href="../FSArchiveResource.html">FSArchiveResource</a> structure that will store the resource information that is obtained.</td>
28</tr>
29</tbody>
30</table>
31
32<h2>Return Values</h2>
33<p>Returns TRUE if the resource information could be 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>
34
35<h2>Description</h2>
36<p>Gets the current resource information for the archive located at the specified path.</p>
37<p>This function is used primarily to check for available space in <a href="../overview/about_Archive.html#FAT">FAT format</a> archives. To determine the Save Data size of a NAND application, also see the information about the <a href="../../tools/SaveDataSize.html">Save Data Size List</a>.</p>
38
39<h2>Note</h2>
40<ul>
41<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>
42</ul>
43
44<h2>See Also</h2>
45<p><code><a href="../../tools/SaveDataSize.html">Save Data Size List</a><br /> <a href="../FSArchiveResource.html">FSArchiveResource</a><br /> <a href="../archive/FS_GetArchiveResultCode.html">FS_GetArchiveResultCode</a></code></p>
46
47<h2>Revision History</h2>
48<p>
492009/01/13 Added a link to the Save Data Size List.<br />2007/12/17 Initial version.
50</p>
51<hr><p>CONFIDENTIAL</p></body>
52</html>
53