| 1110 |
kaklik |
1 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
|
|
2 |
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> |
|
|
3 |
<title>sd-reader: FAT16 access</title> |
|
|
4 |
<link href="doxygen.css" rel="stylesheet" type="text/css"> |
|
|
5 |
<link href="tabs.css" rel="stylesheet" type="text/css"> |
|
|
6 |
</head><body> |
|
|
7 |
<!-- Generated by Doxygen 1.5.3-20071008 --> |
|
|
8 |
<div class="tabs"> |
|
|
9 |
<ul> |
|
|
10 |
<li><a href="index.html"><span>Main Page</span></a></li> |
|
|
11 |
<li><a href="modules.html"><span>Modules</span></a></li> |
|
|
12 |
<li><a href="annotated.html"><span>Data Structures</span></a></li> |
|
|
13 |
<li><a href="files.html"><span>Files</span></a></li> |
|
|
14 |
</ul> |
|
|
15 |
</div> |
|
|
16 |
<h1>FAT16 access<br> |
|
|
17 |
<small> |
|
|
18 |
[<a class="el" href="group__fat16.html">FAT16 support</a>]</small> |
|
|
19 |
</h1><hr><a name="_details"></a><h2>Detailed Description</h2> |
|
|
20 |
Basic functions for handling a FAT16 filesystem. |
|
|
21 |
<p> |
|
|
22 |
|
|
|
23 |
<p> |
|
|
24 |
<table border="0" cellpadding="0" cellspacing="0"> |
|
|
25 |
<tr><td></td></tr> |
|
|
26 |
<tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
|
|
27 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct fat16_fs_struct * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__fat16__fs.html#gc176ec2f1bfa8c81972ea741a941e579">fat16_open</a> (struct <a class="el" href="structpartition__struct.html">partition_struct</a> *partition)</td></tr> |
|
|
28 |
|
|
|
29 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Opens a FAT16 filesystem. <a href="#gc176ec2f1bfa8c81972ea741a941e579"></a><br></td></tr> |
|
|
30 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__fat16__fs.html#g6588833571e6ef0f5d094b8ff56a5985">fat16_close</a> (struct fat16_fs_struct *fs)</td></tr> |
|
|
31 |
|
|
|
32 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Closes a FAT16 filesystem. <a href="#g6588833571e6ef0f5d094b8ff56a5985"></a><br></td></tr> |
|
|
33 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__fat16__fs.html#g8af3c3535929e19b0039e07f1976cec7">fat16_get_fs_size</a> (const struct fat16_fs_struct *fs)</td></tr> |
|
|
34 |
|
|
|
35 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the amount of total storage capacity of the filesystem in bytes. <a href="#g8af3c3535929e19b0039e07f1976cec7"></a><br></td></tr> |
|
|
36 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__fat16__fs.html#g2f8ff07cca44ecb6770b12a58b6cd8c7">fat16_get_fs_free</a> (const struct fat16_fs_struct *fs)</td></tr> |
|
|
37 |
|
|
|
38 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the amount of free storage capacity on the filesystem in bytes. <a href="#g2f8ff07cca44ecb6770b12a58b6cd8c7"></a><br></td></tr> |
|
|
39 |
</table> |
|
|
40 |
<hr><h2>Function Documentation</h2> |
|
|
41 |
<a class="anchor" name="g6588833571e6ef0f5d094b8ff56a5985"></a><!-- doxytag: member="fat16.c::fat16_close" ref="g6588833571e6ef0f5d094b8ff56a5985" args="(struct fat16_fs_struct *fs)" --> |
|
|
42 |
<div class="memitem"> |
|
|
43 |
<div class="memproto"> |
|
|
44 |
<table class="memname"> |
|
|
45 |
<tr> |
|
|
46 |
<td class="memname">void fat16_close </td> |
|
|
47 |
<td>(</td> |
|
|
48 |
<td class="paramtype">struct fat16_fs_struct * </td> |
|
|
49 |
<td class="paramname"> <em>fs</em> </td> |
|
|
50 |
<td> ) </td> |
|
|
51 |
<td width="100%"></td> |
|
|
52 |
</tr> |
|
|
53 |
</table> |
|
|
54 |
</div> |
|
|
55 |
<div class="memdoc"> |
|
|
56 |
|
|
|
57 |
<p> |
|
|
58 |
Closes a FAT16 filesystem. |
|
|
59 |
<p> |
|
|
60 |
When this function returns, the given filesystem descriptor will be invalid.<p> |
|
|
61 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
|
|
62 |
<table border="0" cellspacing="2" cellpadding="0"> |
|
|
63 |
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>fs</em> </td><td>The filesystem to close. </td></tr> |
|
|
64 |
</table> |
|
|
65 |
</dl> |
|
|
66 |
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__fat16.html#gc176ec2f1bfa8c81972ea741a941e579" title="Opens a FAT16 filesystem.">fat16_open</a> </dd></dl> |
|
|
67 |
|
|
|
68 |
</div> |
|
|
69 |
</div><p> |
|
|
70 |
<a class="anchor" name="g2f8ff07cca44ecb6770b12a58b6cd8c7"></a><!-- doxytag: member="fat16.c::fat16_get_fs_free" ref="g2f8ff07cca44ecb6770b12a58b6cd8c7" args="(const struct fat16_fs_struct *fs)" --> |
|
|
71 |
<div class="memitem"> |
|
|
72 |
<div class="memproto"> |
|
|
73 |
<table class="memname"> |
|
|
74 |
<tr> |
|
|
75 |
<td class="memname">uint32_t fat16_get_fs_free </td> |
|
|
76 |
<td>(</td> |
|
|
77 |
<td class="paramtype">const struct fat16_fs_struct * </td> |
|
|
78 |
<td class="paramname"> <em>fs</em> </td> |
|
|
79 |
<td> ) </td> |
|
|
80 |
<td width="100%"></td> |
|
|
81 |
</tr> |
|
|
82 |
</table> |
|
|
83 |
</div> |
|
|
84 |
<div class="memdoc"> |
|
|
85 |
|
|
|
86 |
<p> |
|
|
87 |
Returns the amount of free storage capacity on the filesystem in bytes. |
|
|
88 |
<p> |
|
|
89 |
<dl class="note" compact><dt><b>Note:</b></dt><dd>As the FAT16 filesystem is cluster based, this function does not return continuous values but multiples of the cluster size.</dd></dl> |
|
|
90 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
|
|
91 |
<table border="0" cellspacing="2" cellpadding="0"> |
|
|
92 |
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>fs</em> </td><td>The filesystem on which to operate. </td></tr> |
|
|
93 |
</table> |
|
|
94 |
</dl> |
|
|
95 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 on failure, the free filesystem space in bytes otherwise. </dd></dl> |
|
|
96 |
|
|
|
97 |
</div> |
|
|
98 |
</div><p> |
|
|
99 |
<a class="anchor" name="g8af3c3535929e19b0039e07f1976cec7"></a><!-- doxytag: member="fat16.c::fat16_get_fs_size" ref="g8af3c3535929e19b0039e07f1976cec7" args="(const struct fat16_fs_struct *fs)" --> |
|
|
100 |
<div class="memitem"> |
|
|
101 |
<div class="memproto"> |
|
|
102 |
<table class="memname"> |
|
|
103 |
<tr> |
|
|
104 |
<td class="memname">uint32_t fat16_get_fs_size </td> |
|
|
105 |
<td>(</td> |
|
|
106 |
<td class="paramtype">const struct fat16_fs_struct * </td> |
|
|
107 |
<td class="paramname"> <em>fs</em> </td> |
|
|
108 |
<td> ) </td> |
|
|
109 |
<td width="100%"></td> |
|
|
110 |
</tr> |
|
|
111 |
</table> |
|
|
112 |
</div> |
|
|
113 |
<div class="memdoc"> |
|
|
114 |
|
|
|
115 |
<p> |
|
|
116 |
Returns the amount of total storage capacity of the filesystem in bytes. |
|
|
117 |
<p> |
|
|
118 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
|
|
119 |
<table border="0" cellspacing="2" cellpadding="0"> |
|
|
120 |
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>fs</em> </td><td>The filesystem on which to operate. </td></tr> |
|
|
121 |
</table> |
|
|
122 |
</dl> |
|
|
123 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 on failure, the filesystem size in bytes otherwise. </dd></dl> |
|
|
124 |
|
|
|
125 |
</div> |
|
|
126 |
</div><p> |
|
|
127 |
<a class="anchor" name="gc176ec2f1bfa8c81972ea741a941e579"></a><!-- doxytag: member="fat16.c::fat16_open" ref="gc176ec2f1bfa8c81972ea741a941e579" args="(struct partition_struct *partition)" --> |
|
|
128 |
<div class="memitem"> |
|
|
129 |
<div class="memproto"> |
|
|
130 |
<table class="memname"> |
|
|
131 |
<tr> |
|
|
132 |
<td class="memname">struct fat16_fs_struct* fat16_open </td> |
|
|
133 |
<td>(</td> |
|
|
134 |
<td class="paramtype">struct <a class="el" href="structpartition__struct.html">partition_struct</a> * </td> |
|
|
135 |
<td class="paramname"> <em>partition</em> </td> |
|
|
136 |
<td> ) </td> |
|
|
137 |
<td width="100%"><code> [read]</code></td> |
|
|
138 |
</tr> |
|
|
139 |
</table> |
|
|
140 |
</div> |
|
|
141 |
<div class="memdoc"> |
|
|
142 |
|
|
|
143 |
<p> |
|
|
144 |
Opens a FAT16 filesystem. |
|
|
145 |
<p> |
|
|
146 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
|
|
147 |
<table border="0" cellspacing="2" cellpadding="0"> |
|
|
148 |
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>partition</em> </td><td>Discriptor of partition on which the filesystem resides. </td></tr> |
|
|
149 |
</table> |
|
|
150 |
</dl> |
|
|
151 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 on error, a FAT16 filesystem descriptor on success. </dd></dl> |
|
|
152 |
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__fat16.html#gc176ec2f1bfa8c81972ea741a941e579" title="Opens a FAT16 filesystem.">fat16_open</a> </dd></dl> |
|
|
153 |
|
|
|
154 |
</div> |
|
|
155 |
</div><p> |
|
|
156 |
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Dec 13 19:38:48 2007 for sd-reader by |
|
|
157 |
<a href="http://www.doxygen.org/index.html"> |
|
|
158 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3-20071008 </small></address> |
|
|
159 |
</body> |
|
|
160 |
</html> |