NANDRead

Syntax

#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.

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. One of the following codes is returned on failure.

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 sometimes puts the current thread to sleep, so it cannot be called from callback functions. For precautions related to calling similar functions, see Interrupts and Callback Functions.

If, while the NANDRead function is processing, certain functions or combinations of functions are called from a different thread, the processing of these other functions may be delayed or even fail. For more information about the occurrence conditions, symptoms, and workarounds, see Notes Regarding Read/Writes to Wii Console NAND Memory.

Revision History

2009/12/02 Added the Notes Regarding Read/Writes to Wii Console NAND Memory information.
2007/09/25 Added information about the sleep status of threads.
2006/11/30 Added the NAND_RESULT_ALLOC_FAILED and NAND_RESULT_BUSY codes.
2006/10/xx Unified terminology.
2006/08/15 Added the AUTHENTICATION result code.
2006/06/16 Initial version.