nn::fs::FormatSaveData Function

Syntax

Result FormatSaveData(
     size_t maxFiles,
     size_t maxDirectories,
     bool isDuplicateAll = false
);

Arguments

Name Description
in maxFiles Specifies the maximum number of files.
in maxDirectories Specifies the maximum number of directories.
in isDuplicateAll Specifies whether to duplicate the entire save data region.

Return Values

Returns the result of the operation.
Value Description
Success. Process was successful. The return value's IsSuccess function returns true in this state.
ResultNotEnoughSpace The values of maxFiles and maxDirectories are too large for save data. You must not allow this error to occur in retail products.
A value other than the above. An unexpected or fatal error occurred.

Description

Formats a save data region.

Formats an application-specific save data region. Calling this function will erase any save data that may have existed there.

When you format this save data region, you can specify the maximum number of files and directories that it can hold. Note that you cannot create any more than this number of files and directories.

When formatting with isDuplicateAll set to true, be sure to call the CommitSaveData function before unmounting the save data.

Revision History

2010/12/14
Added return values.
2010/08/16
Initial version.

CONFIDENTIAL