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=utf-8">
6<META http-equiv="Content-Style-Type" content="text/css">
7<LINK rel="stylesheet" type="text/css" href="../CSS/revolution.css">
8<title>NANDCreateAsync</title>
9</head>
10
11<body>
12
13<h1>NANDCreateAsync</h1>
14
15<h2>Syntax</h2>
16<dl><dd><pre class="construction">
17#include <revolution/nand.h>
18
19#define NAND_PERM_OTHER_READ   0x01
20#define NAND_PERM_OTHER_WRITE  0x02
21#define NAND_PERM_GROUP_READ   0x04
22#define NAND_PERM_GROUP_WRITE  0x08
23#define NAND_PERM_OWNER_READ   0x10
24#define NAND_PERM_OWNER_WRITE  0x20
25
26typedef void (*NANDCallback)( s32 result, NANDCommandBlock *block );
27
28s32 NANDCreateAsync( const char *filename, u8 perm, u8 attr, NANDCallback cb, NANDCommandBlock *block );
29</pre></dd></dl>
30
31<h2>Arguments</h2>
32<p>
33<TABLE class="arguments" border="1" >
34  <tr>
35<TH><STRONG><EM><CODE>filename</CODE></EM></STRONG></TH>
36<TD>Specifies the filename.</TD>
37  </tr>
38  <tr>
39<TH><STRONG><EM><CODE>perm</CODE></EM></STRONG></TH>
40<TD>File permissions. Specified by taking the bitwise OR of <code>NAND_PERM_*</code>.</TD>
41  </tr>
42  <tr>
43<TH><STRONG><EM><CODE>attr</CODE></EM></STRONG></TH>
44<TD>Specifies the file attributes.</TD>
45  </tr>
46  <tr>
47<TH>cb</TH>
48<TD>Callback function to call when this function completes processing.</TD>
49  </tr>
50  <tr>
51<TH>block</TH>
52<TD>Command block structure to be passed to the callback function.</TD>
53  </tr>
54</TABLE>
55</p>
56
57<h2>Return Values</h2>
58<p>
59The result codes that may be returned by <code>NANDCreateAsync</code> are listed below. Returns <CODE>NAND_RESULT_OK</CODE> when the request begins normally.
60<p>
61<code>NAND_RESULT_OK<br> NAND_RESULT_ACCESS<br> NAND_RESULT_ALLOC_FAILED<br> NAND_RESULT_BUSY<br> NAND_RESULT_INVALID<br> NAND_RESULT_FATAL_ERROR<br></code>
62</p>
63<p>
64The result codes that may be passed to the callback function are listed below.
65</p>
66<p>
67<code>NAND_RESULT_OK<br> NAND_RESULT_ACCESS<br> NAND_RESULT_CORRUPT<br> NAND_RESULT_EXISTS<br> NAND_RESULT_INVALID<br> NAND_RESULT_MAXFILES<br> NAND_RESULT_NOEXISTS<br> NAND_RESULT_UNKNOWN<br> NAND_RESULT_FATAL_ERROR<br></code>
68</p>
69</p>
70
71<H2>Description</H2>
72<p>
73Asynchronously creates a new file. The specified permissions and attributes are given to the file. <font color="#ff0000">At a minimum, the file must be granted <CODE>NAND_PERM_OWNER_READ</CODE> permission.</font> If <CODE>NAND_PERM_OWNER_READ</CODE> permission is not granted, the function returns <CODE>NAND_RESULT_INVALID</CODE>. If nonusable characters are used for the filename, the function returns <CODE>NAND_RESULT_INVALID</CODE>. The usable characters include three symbols [ <CODE><B>_</B></CODE> <CODE><B>-</B></CODE> <CODE><B>.</B></CODE> ], and all alphanumeric characters (0-9, a-z, and A-Z). <code>NAND_RESULT_BUSY</code> is returned and this function call is denied when the queue for accepting requests inside the library is full.
74</p>
75
76<p>
77This function updates the FAT of the Wii console NAND memory.
78</p>
79
80<h2>See Also</h2>
81<p class="reference">
82<a href="./NANDCreate.html">NANDCreate</a><BR><a href="./NANDDelete.html">NANDDelete</a><BR><a href="./NANDDeleteAsync.html">NANDDeleteAsync</a>
83</p>
84
85<H2>Revision History</H2>
86<p>
872009/07/28 Explained that <CODE>NAND_RESULT_INVALID</CODE> is returned when an invalid filename is specified for the argument.<br> 2008/08/01 Revised the result codes that are passed to the callback function.<br> 2008/05/13 Added description of the result codes passed to the callback function.<br> 2008/04/23 Commented about updating the FAT.<br>2006/11/13 Added an explanation about the need to grant <CODE>NAND_PERM_OWNER_READ</CODE> permission.<br>2006/08/30 Added the <CODE>NAND_RESULT_NOEXISTS</CODE> result code.<br> 2006/06/16 Initial version.<BR>
88</p>
89
90<hr><p>CONFIDENTIAL</p></body>
91</html>
92