NANDRead

C Specification


#include <revolution/nand.h>

s32 NANDRead(NANDFileInfo *info, void *buf, u32 length);

Arguments

info Pointer to a NANDFileInfo structure.
buf Pointer to the write destination for the data that was read. The write buffer must be 32-byte aligned.
length Number of bytes to read. This value must be a multiple of 32.

Return Values

Returns the number of bytes for the read data when the read is successful. When the write fails, one of the following codes is returned:

NAND_RESULT_ACCESS
NAND_RESULT_ALLOC_FAILED
NAND_RESULT_AUTHENTICATION
NAND_RESULT_BUSY
NAND_RESULT_CORRUPT
NAND_RESULT_ECC_CRIT
NAND_RESULT_INVALID
NAND_RESULT_UNKNOWN
NAND_RESULT_FATAL_ERROR

Description

Reads data from a file in Wii console NAND memory.

This function may put the current thread to sleep. For precautions when calling similar functions, refer to Interrupts and Callback Functions.

See Also

NANDReadAsync, NANDWrite, NANDWriteAsync, NANDSeek, NANDSeekAsync, Interrupts and Callback Functions

Revision History

2007/09/25 Added information on the sleep status of threads.
2006/11/30 Added NAND_RESULT_ALLOC_FAILED and NAND_RESULT_BUSY codes.
2006/10/xx Unified terminology.
2006/08/15 Added AUTHENTICATION result code.
2006/06/16 Initial version.


CONFIDENTIAL