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 http-equiv="Content-Style-Type" content="text/css">
7<LINK rel="stylesheet" type="text/css" href="../CSS/revolution.css">
8<title>NANDFreeBlocks</title>
9</head>
10
11<body>
12
13<h1>NANDFreeBlocks</h1>
14
15<h2>C Specification</h2>
16<dl><dd><pre><code>
17#include &lt;revolution/nand.h&gt;
18
19s32 NANDFreeBlocks(u32 *bytes, u32 *inodes);
20</code></pre></dd></dl>
21
22<h2>Arguments</h2>
23<p>
24<TABLE border="1" >
25  <tr>
26<TD valign="top" width="120" bgcolor="#ffffe8"><CODE><STRONG><EM>bytes</EM></STRONG></CODE></TD>
27<TD width="520">A pointer to a u32 type variable that stores (in bytes) the file system's available space.</TD>
28  </tr>
29  <tr>
30<TD valign="top" width="120" bgcolor="#ffffe8"><CODE><STRONG><EM>inodes</EM></STRONG></CODE></TD>
31<TD width="520">A pointer to a u32 type variable that stores the number of free inodes in the file system.</TD>
32  </tr>
33</TABLE>
34</p>
35
36
37<h2>Return Values</h2>
38<p>
39Returns one of the following codes:
40<p>
41<code>NAND_RESULT_OK<br> NAND_RESULT_ALLOC_FAILED<br> NAND_RESULT_BUSY<br> NAND_RESULT_INVALID<br> NAND_RESULT_UNKNOWN<br> NAND_RESULT_FATAL_ERROR<br></code>
42</p>
43</p>
44
45<H2>Description</H2>
46<p>
47Obtains the file system's available free space (in bytes) and the number of free inodes. However, <font color="ff0000">you cannot use this function to determine whether new files or directories can be created</font> (to protect the free space reserved by the system). To determine whether new files and directories can be created, use <code>NANDCheck[Async]</code> or <code>NANDGetAvailableArea[Async]</code>.
48</p>
49
50<p>
51This function may put the current thread to sleep. For precautions when calling similar functions, refer to <a href="../os/Interrupt/intro.html">Interrupts and Callback Functions</a>.
52</p>
53
54<h2>See Also</h2>
55<p>
56<code><a href="./NANDFreeBlocksAsync.html">NANDFreeBlocksAsync</a></code>, <code><a href="./NANDCheck.html">NANDCheck</a></code>, <code><a href="./NANDCheckAsync.html">NANDCheckAsync</a></code>, <code><a href="./NANDGetAvailableArea.html">NANDGetAvailableArea</a></code>, <code><a href="./NANDGetAvailableAreaAsync.html">NANDGetAvailableAreaAsync</a></code>, <a href="../os/Interrupt/intro.html">Interrupts and Callback Functions</a>
57</p>
58
59<H2>Revision History</H2>
60<p>
612007/09/25 Added information on the sleep status of threads.<br>2006/11/30 Added <CODE>NAND_RESULT_ALLOC_FAILED</CODE> and <CODE>NAND_RESULT_BUSY</CODE> codes.<br>2006/10/25 Expanded statement to include NANDGetAvailableArea[Async]. Added links to <B>See Also</B>.<br>2006/08/30 Added caution regarding the creation of new files and directories.<BR>2006/06/16 Initial version.<br>
62</p>
63
64<hr><p>CONFIDENTIAL</p></body>
65</html>
66