NANDSimpleSafeOpen

Syntax

#include <revolution/nand.h>

#define NAND_ACCESS_READ       0x01
#define NAND_ACCESS_WRITE      0x02
#define NAND_ACCESS_RW         (NAND_ACCESS_READ | NAND_ACCESS_WRITE)

s32 NANDSimpleSafeOpen(const char *path, NANDFileInfo *info, u8 accType, void *buf, u32 length);

Arguments

path Name of the file to open.

info Pointer to a NANDFileInfo structure.

accType Access type. Specifies either NAND_ACCESS_READ, NAND_ACCESS_WRITE or NAND_ACCESS_RW.

buf Specifies the leading address of the buffer to be used when copying files. The buffer must be 32-byte aligned.

length Specifies the size of the buffer to be used when copying files. The size must be a multiple of NAND_FSBLOCK_SIZE (16 KB).

path	Name of the file to open.
info	Pointer to a `NANDFileInfo` structure.
accType	Access type. Specifies either `NAND_ACCESS_READ`, `NAND_ACCESS_WRITE` or `NAND_ACCESS_RW`.
buf	Specifies the leading address of the buffer to be used when copying files. The buffer must be 32-byte aligned.
length	Specifies the size of the buffer to be used when copying files. The size must be a multiple of `NAND_FSBLOCK_SIZE` (16 KB).

Return Values

Returns one of the following codes.

NAND_RESULT_OK NAND_RESULT_ACCESS NAND_RESULT_ALLOC_FAILED NAND_RESULT_AUTHENTICATION NAND_RESULT_BUSY NAND_RESULT_CORRUPT NAND_RESULT_ECC_CRIT NAND_RESULT_EXISTS NAND_RESULT_INVALID NAND_RESULT_MAXBLOCKS NAND_RESULT_MAXFD NAND_RESULT_MAXFILES NAND_RESULT_NOEXISTS NAND_RESULT_UNKNOWN NAND_RESULT_FATAL_ERROR

Description

Opens a file in a manner that guarantees the atomic nature of file updates. The file opened using this function must be closed using either the NANDSimpleSafeClose or the NANDSimpleSafeCloseAsync function. Appropriate permissions (both read and write) must be set for the parent directory of the file to which NANDSimpleSafe-type functions are applied.

This function cannot simultaneously open multiple files with the same name (for example, ~/userA/save.dat and ~/userB/save.dat). NAND_RESULT_EXISTS will be returned.

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

When NAND_ACCESS_WRITE or NAND_ACCESS_RW is specified for accType, this function will update the FAT in Wii console NAND memory.

Revision History

2008/08/01 Added an explanation related to FAT updates.
2007/09/25 Added information on the sleep status of threads.
2007/05/09 Initial version.