NA_FormatTitleArchive

Syntax

#include <twl/na.h>

FSResult NA_FormatTitleArchive(NATitleArchive archive);

Arguments

archive Sets the save data region to initialize.

Return Values

Returns FS_RESULT_SUCCESS if processing completed successfully.
Other values indicate an error. The following values, in particular, have specific meanings.

FS_RESULT_UNSUPPORTEDThis is running on the Nintendo DS system and cannot be used.

Description

Initializes the specified save data region. Applications can initialize only their own save data region. (Save data regions for other applications cannot be initialized.)

Initializing the save data region deletes all directories and files contained therein. It also fixes the type of file system corruption indicated when FS_RESULT_BAD_FORMAT is returned by the FS library functions.

The time required for initialization with this function is proportionate to the size of the save data region. It takes approximately 10 seconds per MB, so be sure to follow the various programming guidelines regarding what to display. Note that this is a synchronous function, so control does not return until the processing has completed.

See Also

Revision History

2008/11/26 Clarified that this is a synchronous function.
2008/09/26 Initial version.


CONFIDENTIAL