1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<HTML>
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<LINK rel="stylesheet" type="text/css" href="../CSS/revolution.css">
7<BASE target="main">
8<TITLE>Wii Console NAND Memory (NAND) API Function List</TITLE>
9</HEAD>
10<BODY>
11<H1>Wii Console NAND Memory (NAND) API Function List</H1>
12
13<H2><a name="Initialize">Initialization</a></H2>
14<TABLE class="api_list" border="1">
15  <TBODY>
16    <tr>
17<th><a href="./NANDInit.html">NANDInit</a></th>
18<td>Initializes the NAND library.</td>
19    </tr>
20  </TBODY>
21</TABLE>
22
23<H2><a name="File">File Access</a></H2>
24<TABLE class="api_list" border="1">
25  <TBODY>
26    <tr>
27<th><a href="./NANDCreate.html">NANDCreate</a></th>
28<td>Creates a file.</td>
29    </tr>
30    <tr>
31<th><a href="./NANDCreateAsync.html">NANDCreateAsync</a></th>
32<td>Asynchronously creates a file.</td>
33    </tr>
34    <tr>
35<th><a href="./NANDOpen.html">NANDOpen</a></th>
36<td>Opens a file.</td>
37    </tr>
38    <tr>
39<th><a href="./NANDOpenAsync.html">NANDOpenAsync</a></th>
40<td>Asynchronously opens a file.</td>
41    </tr>
42    <tr>
43<th><a href="./NANDClose.html">NANDClose</a></th>
44<td>Closes a file.</td>
45    </tr>
46    <tr>
47<th><a href="./NANDCloseAsync.html">NANDCloseAsync</a></th>
48<td>Asynchronously closes a file.</td>
49    </tr>
50    <tr>
51<th><a href="./NANDRead.html">NANDRead</a></th>
52<td>Reads data from a file.</td>
53    </tr>
54    <tr>
55<th><a href="./NANDReadAsync.html">NANDReadAsync</a></th>
56<td>Asynchronously reads data from a file.</td>
57    </tr>
58    <tr>
59<th><a href="./NANDWrite.html">NANDWrite</a></th>
60<td>Writes data to a file.</td>
61    </tr>
62    <tr>
63<th><a href="./NANDWriteAsync.html">NANDWriteAsync</a></th>
64<td>Asynchronously writes data to a file.</td>
65    </tr>
66    <tr>
67<th><a href="./NANDSeek.html">NANDSeek</a></th>
68<td>Performs a file seek.</td>
69    </tr>
70    <tr>
71<th><a href="./NANDSeekAsync.html">NANDSeekAsync</a></th>
72<td>Asynchronously performs a file seek.</td>
73    </tr>
74    <tr>
75<th><a href="./NANDTell.html">NANDTell</a></th>
76<td>Returns the current position of the file.</td>
77    </tr>
78    <tr>
79<th><a href="./NANDTellAsync.html">NANDTellAsync</a></th>
80<td>Asynchronously returns the current position of a file.</td>
81    </tr>
82    <tr>
83<th><a href="./NANDGetLength.html">NANDGetLength</a></th>
84<td>Gets the file size.</td>
85    </tr>
86    <tr>
87<th><a href="./NANDGetLengthAsync.html">NANDGetLengthAsync</a></th>
88<td>Asynchronously gets the file size.</td>
89    </tr>
90    <tr>
91<th><a href="./NANDSimpleSafeOpen.html">NANDSimpleSafeOpen</a></th>
92<td>Opens a file while guaranteeing the atomicity of file updates.</td>
93    </tr>
94    <tr>
95<th><a href="./NANDSimpleSafeOpenAsync.html">NANDSimpleSafeOpenAsync</a></th>
96<td>Asynchronously opens a file while guaranteeing the atomicity of file updates.</td>
97    </tr>
98    <tr>
99<th><a href="./NANDSimpleSafeClose.html">NANDSimpleSafeClose</a></th>
100<td>Closes a file while guaranteeing the atomicity of file updates.</td>
101    </tr>
102    <tr>
103<th><a href="./NANDSimpleSafeCloseAsync.html">NANDSimpleSafeCloseAsync</a></th>
104<td>Asynchronously closes a file while guaranteeing the atomicity of file updates.</td>
105    </tr>
106    <tr>
107<th><a href="./NANDSimpleSafeCancel.html">NANDSimpleSafeCancel</a></th>
108<td>Deallocates the resources that were in use when a <CODE>NANDSimpleSafe</CODE>-related function terminated with an error.</td>
109    </tr>
110    <tr>
111<th><a href="./NANDSimpleSafeCancelAsync.html">NANDSimpleSafeCancelAsync</a></th>
112<td>Asynchronously deallocates the resources that were in use when a <CODE>NANDSimpleSafe</CODE>-related function terminated with an error.</td>
113    </tr>
114    <tr>
115<th><a href="./NANDSafeOpen.html">NANDSafeOpen</a></th>
116<td>Opens a file while guaranteeing the atomicity of file updates (not recommended).</td>
117    </tr>
118    <tr>
119<th><a href="./NANDSafeOpenAsync.html">NANDSafeOpenAsync</a></th>
120<td>Asynchronously opens a file while guaranteeing the atomicity of file updates (not recommended).</td>
121    </tr>
122    <tr>
123<th><a href="./NANDSafeClose.html">NANDSafeClose</a></th>
124<td>Closes a file while guaranteeing the atomicity of file updates (not recommended).</td>
125    </tr>
126    <tr>
127<th><a href="./NANDSafeCloseAsync.html">NANDSafeCloseAsync</a></th>
128<td>Asynchronously closes a file while guaranteeing the atomicity of file updates (not recommended).</td>
129    </tr>
130  </TBODY>
131</TABLE>
132
133<H2><a name="Directory">Directory Access</a></H2>
134<TABLE class="api_list" border="1">
135  <tbody>
136    <tr>
137<th><a href="./NANDReadDir.html">NANDReadDir</a></th>
138<td>Gets a list of file or directory names stored in the directory.</td>
139    </tr>
140    <tr>
141<th><a href="./NANDReadDirAsync.html">NANDReadDirAsync</a></th>
142<td>Asynchronously gets a list of file or directory names stored in the directory.</td>
143    </tr>
144    <tr>
145<th><a href="./NANDCreateDir.html">NANDCreateDir</a></th>
146<td>Creates a directory.</td>
147    </tr>
148    <tr>
149<th><a href="./NANDCreateDirAsync.html">NANDCreateDirAsync</a></th>
150<td>Asynchronously creates a directory.</td>
151    </tr>
152    <tr>
153<th><a href="./NANDChangeDir.html">NANDChangeDir</a></th>
154<td>Changes the current directory.</td>
155    </tr>
156    <tr>
157<th><a href="./NANDChangeDirAsync.html">NANDChangeDirAsync</a></th>
158<td>Asynchronously changes the current directory.</td>
159    </tr>
160    <tr>
161<th><a href="./NANDGetCurrentDir.html">NANDGetCurrentDir</a></th>
162<td>Gets the current directory.</td>
163    </tr>
164    <tr>
165<th><a href="./NANDGetHomeDir.html">NANDGetHomeDir</a></th>
166<td>Gets the home directory.</td>
167    </tr>
168  </tbody>
169</table>
170
171<H2><a name="File Directory">File or Directory Access</a></H2>
172<TABLE class="api_list" border="1">
173  <tbody>
174    <tr>
175<th><a href="./NANDDelete.html">NANDDelete</a></th>
176<td>Deletes a file or directory.</td>
177    </tr>
178    <tr>
179<th><a href="./NANDDeleteAsync.html">NANDDeleteAsync</a></th>
180<td>Asynchronously deletes a file or directory.</td>
181    </tr>
182    <tr>
183<th><a href="./NANDMove.html">NANDMove</a></th>
184<td>Moves a file or directory.</td>
185    </tr>
186    <tr>
187<th><a href="./NANDMoveAsync.html">NANDMoveAsync</a></th>
188<td>Asynchronously moves a file or directory.</td>
189    </tr>
190    <tr>
191<th><a href="./NANDSetStatus.html">NANDSetStatus</a></th>
192<td>Configures the status information of a file or directory.</td>
193    </tr>
194    <tr>
195<th><a href="./NANDSetStatusAsync.html">NANDSetStatusAsync</a></th>
196<td>Asynchronously configures the status information of a file or directory.</td>
197    </tr>
198    <tr>
199<th><a href="./NANDGetStatus.html">NANDGetStatus</a></th>
200<td>Gets the status information of a file or directory.</td>
201    </tr>
202    <tr>
203<th><a href="./NANDGetStatusAsync.html">NANDGetStatusAsync</a></th>
204<td>Asynchronously gets the status information of a file or directory.</td>
205    </tr>
206    <tr>
207<th><a href="./NANDGetType.html">NANDGetType</a></th>
208<td>Checks whether the specified path name represents a file or a directory.</td>
209    </tr>
210    <tr>
211<th><a href="./NANDGetTypeAsync.html">NANDGetTypeAsync</a></th>
212<td>Asynchronously checks whether the specified path name is for a file or a directory.</td>
213    </tr>
214  </tbody>
215</table>
216
217<H2><a name="File System">File System Access</a></H2>
218<TABLE class="api_list" border="1">
219  <tbody>
220    <tr>
221<th><a href="./NANDFreeBlocks.html">NANDFreeBlocks</a></th>
222<td>Gets the amount of available space in the file system and the number of empty inodes.</td>
223    </tr>
224    <tr>
225<th><a href="./NANDFreeBlocksAsync.html">NANDFreeBlocksAsync</a></th>
226<td>Asynchronously gets the the amount of available space in the file system and the number of empty inodes.</td>
227    </tr>
228    <tr>
229<th><a href="./NANDCheck.html">NANDCheck</a></th>
230<td>Checks whether new files or directories can be created.</td>
231    </tr>
232    <tr>
233<th><a href="./NANDCheckAsync.html">NANDCheckAsync</a></th>
234<td>Asynchronously checks whether new files or directories can be created.</td>
235    </tr>
236    <tr>
237<th><a href="./NANDGetAvailableArea.html">NANDGetAvailableArea</a></th>
238<td>Gets the number of FS blocks and inodes available for use by the application.</td>
239    </tr>
240    <tr>
241<th><a href="./NANDGetAvailableAreaAsync.html">NANDGetAvailableAreaAsync</a></th>
242<td>Asynchronously gets the number of FS blocks and inodes available for use by the application.</td>
243    </tr>
244    <tr>
245<th><a href="./NANDGetTmpDirUsage.html">NANDGetTmpDirUsage</a></th>
246<td>Gets the number of FS blocks and inodes used under the <CODE>/tmp</CODE> directory.</td>
247    </tr>
248    <tr>
249<th><a href="./NANDGetTmpDirUsageAsync.html">NANDGetTmpDirUsageAsync</a></th>
250<td>Asynchronously gets the number of FS blocks and inodes used under the <CODE>/tmp</CODE> directory.</td>
251    </tr>
252    <tr>
253<th><a href="./NANDGetHomeDirUsage.html">NANDGetHomeDirUsage</a></th>
254<td>Gets the number of FS blocks and inodes used under the home directory.</td>
255    </tr>
256    <tr>
257<th><a href="./NANDGetHomeDirUsageAsync.html">NANDGetHomeDirUsageAsync</a></th>
258<td>Asynchronously gets the number of FS blocks and inodes used under the home directory.</td>
259    </tr>
260  </tbody>
261</table>
262
263<h2><a name="User Data">User Data Access</a></h2>
264<TABLE class="api_list" border="1">
265  <tbody>
266    <tr>
267<th><a href="./NANDSetUserData.html">NANDSetUserData</a></th>
268<td>Sets user data in a command block.</td>
269    </tr>
270    <tr>
271<th><a href="./NANDGetUserData.html">NANDGetUserData</a></th>
272<td>Gets user data from a command block.</td>
273    </tr>
274  </tbody>
275</table>
276
277<h2><a name="Banner">Banner Files</a></h2>
278<TABLE class="api_list" border="1">
279  <tbody>
280    <tr>
281<th><a href="./NANDInitBanner.html">  NANDInitBanner</a></th>
282<td>Initializes the banner structure.</td>
283    </tr>
284    <tr>
285<th><a href="./NANDGetIconSpeed.html">NANDGetIconSpeed</a></th>
286<td>Gets the amount of time that the icon in the banner is displayed.</td>
287    </tr>
288    <tr>
289<th><a href="./NANDSetIconSpeed.html">NANDSetIconSpeed</a></th>
290<td>Sets the amount of time that the icon in the banner is displayed.</td>
291    </tr>
292  </tbody>
293</table>
294
295<h2><a name="struct">Types and Structures</a></h2>
296<TABLE class="api_list" border="1">
297  <TBODY>
298    <tr>
299<th><a href="./NANDFileInfo.html">NANDFileInfo</a></th>
300<td>File structure in the NAND library.</td>
301    </tr>
302    <tr>
303<th><a href="./NANDStatus.html">NANDStatus</a></th>
304<td>Status structure that stores owner ID, groupID, attributes, and permissions.</td>
305    </tr>
306    <tr>
307<th><a href="./NANDCommandBlock.html">NANDCommandBlock</a></th>
308<td>Command block structure used inside the library to process asynchronous function requests.</td>
309    </tr>
310    <tr>
311<th><a href="./NANDBanner.html">NANDBanner</a></th>
312<td>Banner structure that stores a save file's banner information.</td>
313    </tr>
314  </TBODY>
315</TABLE>
316<BR><BR>
317<hr><p>CONFIDENTIAL</p></body>
318</HTML>
319