nn::fs::MountSaveData Function

Syntax

Result MountSaveData(
     const char * archiveName = "data:"
);

Parameters

Name Description
in archiveName Specifies the name of the archive. (If this argument is omitted, "data:" is specified.)

Return Values

Returns the result of the operation.
Value Description
Result::IsSuccess Process was successful.
ResultAlreadyExists The specified archive name is already mounted.
You must not allow this error to occur in retail products.
ResultOperationDenied Operation denied because the save data are currently being mounted.
You must not allow this error to occur in retail products.
ResultNotFormatted Data region not formatted. Format the data region by calling the FormatSaveData function.
ResultBadFormat Data region format invalid. Format the data region by calling the FormatSaveData function.
ResultVerificationFailed Either verification failed or some form of tampering was detected. Format the data region by calling the FormatSaveData function.
A value other than the above. An application bug or some other unexpected error.

Description

Mounts a save data archive.

Mounts an application-specific save data region and gives it the specified archive name. The save data region must be formatted before it can be used.

Be sure to check the return value when you call this function to determine whether the save data region is invalid. If the save data region is invalid, call the FormatSaveData function to initialize it. Call this function again afterwards to mount it.

The following page has hints on how to handle mount errors. Please use this as a reference.

Revision History

2012/04/26
Separated the demo-version functions.
2012/02/16
Deleted text about double mounting.
Added overloaded version for mounting save data from other applications.
2011/04/15
Added text about double mounting.
2011/04/13
Added ResultOperationDenied to the Return Values.
2010/12/15
Added a link to the error handling page.
2010/08/16
Initial version.

CONFIDENTIAL