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>C Specification</h2>
16<dl><dd><pre><code>
17#include &lt;revolution/nand.h&gt;
18
19s32 NANDRead(NANDFileInfo *info, void *buf, u32 length);
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>info</EM></STRONG></CODE></TD>
27<TD width="520">Pointer to a <CODE>NANDFileInfo</CODE> structure.</TD>
28  </tr>
29  <tr>
30<TD valign="top" width="120" bgcolor="#ffffe8"><CODE><STRONG><EM>buf</EM></STRONG></CODE></TD>
31<TD width="520">Pointer to the write destination for the data that was read. The write buffer must be 32-byte aligned.</TD>
32  </tr>
33  <tr>
34<TD valign="top" width="120" bgcolor="#ffffe8"><CODE><STRONG><EM>length</EM></STRONG></CODE></TD>
35<TD width="520">Number of bytes to read. This value must be a multiple of 32.</TD>
36  </tr>
37</TABLE>
38</p>
39
40<h2>Return Values</h2>
41<p>
42Returns the number of bytes for the read data when the read is successful. When the write fails, one of the following codes is returned:
43<p>
44<code>NAND_RESULT_ACCESS<br> NAND_RESULT_ALLOC_FAILED<br> NAND_RESULT_AUTHENTICATION<br> NAND_RESULT_BUSY<br> NAND_RESULT_CORRUPT<br> NAND_RESULT_ECC_CRIT<br> NAND_RESULT_INVALID<br> NAND_RESULT_UNKNOWN<br> NAND_RESULT_FATAL_ERROR<br></code>
45</p>
46</p>
47
48<H2>Description</H2>
49<p>
50Reads data from a file in Wii console NAND memory.
51</p>
52
53<p>
54This 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>.
55</p>
56
57<h2>See Also</h2>
58<p>
59<code><a href="./NANDReadAsync.html">NANDReadAsync</a></code>, <code><a href="./NANDWrite.html">NANDWrite</a></code>, <code><a href="./NANDWriteAsync.html">NANDWriteAsync</a></code>, <code><a href="./NANDSeek.html">NANDSeek</a></code>, <code><a href="./NANDSeekAsync.html">NANDSeekAsync</a></code>, <a href="../os/Interrupt/intro.html">Interrupts and Callback Functions</a>
60</p>
61
62<H2>Revision History</H2>
63<p>
642007/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/xx Unified terminology.<br>2006/08/15 Added AUTHENTICATION result code.<br>2006/06/16 Initial version.<br>
65</p>
66
67
68<hr><p>CONFIDENTIAL</p></body>
69</html>
70