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>NANDRead</title>
9</head>
10
11<body>
12
13<h1>NANDRead</h1>
14
15<h2>Syntax</h2>
16<dl><dd><pre class="construction">#include &lt;revolution/nand.h&gt;
17
18s32 NANDRead(NANDFileInfo *info, void *buf, u32 length);
19</pre></dd></dl>
20
21<h2>Arguments</h2>
22<p>
23<TABLE class="arguments" border="1" >
24  <tr>
25<TH>info</TH>
26<TD>Pointer to a <CODE>NANDFileInfo</CODE> structure.</TD>
27  </tr>
28  <tr>
29<TH>buf</TH>
30<TD>Pointer to the write destination for the data that was read. The write buffer must be 32-byte aligned.</TD>
31  </tr>
32  <tr>
33<TH>length</TH>
34<TD>Number of bytes to read. This value must be a multiple of 32.</TD>
35  </tr>
36</TABLE>
37</p>
38
39<h2>Return Values</h2>
40<p>
41Returns the number of bytes for the read data when the read is successful. One of the following codes is returned on failure.
42<p>
43<code>
44NAND_RESULT_ACCESS<br>
45NAND_RESULT_ALLOC_FAILED<br>
46NAND_RESULT_AUTHENTICATION<br>
47NAND_RESULT_BUSY<br>
48NAND_RESULT_CORRUPT<br>
49NAND_RESULT_ECC_CRIT<br>
50NAND_RESULT_INVALID<br>
51NAND_RESULT_UNKNOWN<br>
52NAND_RESULT_FATAL_ERROR<br>
53</code>
54</p>
55</p>
56
57<H2>Description</H2>
58<p>
59Reads data from a file in Wii console NAND memory.
60</p>
61
62<p>
63This function may put the current thread to sleep. For precautions related to calling similar functions, see <a href="../os/Interrupt/intro.html">Interrupts and Callback Functions</a>.
64</p>
65
66<h2>See Also</h2>
67<p class="reference">
68<a href="./NANDReadAsync.html">NANDReadAsync</a>,
69<a href="./NANDWrite.html">NANDWrite</a>,
70<a href="./NANDWriteAsync.html">NANDWriteAsync</a>,
71<a href="./NANDSeek.html">NANDSeek</a>,
72<a href="./NANDSeekAsync.html">NANDSeekAsync</a>,
73<a href="../os/Interrupt/intro.html">Interrupts and Callback Functions</a>
74</p>
75
76<H2>Revision History</H2>
77<p>
782007/09/25 Added information about the sleep status of threads.<br>2006/11/30 Added the <CODE>NAND_RESULT_ALLOC_FAILED</CODE> and <CODE>NAND_RESULT_BUSY</CODE> codes.<br>2006/10/xx Unified terminology.<br>2006/08/15 Added the <CODE>AUTHENTICATION</CODE> result code.<br>2006/06/16 Initial version.<BR>
79</p>
80
81<hr><p>CONFIDENTIAL</p></body>
82</html>