nn::fs::MountSaveData Function

Syntax

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

Arguments

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.
Make sure that this error never occurs in retail products.
ResultNotFormatted Data region not formatted. Format it by calling the FormatSaveData function.
ResultBadFormat Data region format invalid. Format it by calling the FormatSaveData function.
ResultVerificationFailed Either verification failed or some form of tampering was detected. Format it 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.

Double mounting

When the save data are mounted a second time, the correct behavior is to treat this as an error and return nn::fs::ResultOperationDenied. However, because of a bug, some versions of the CTR-SDK return a different Result.

SDK versionReturn Values
1.2 and earlier versionsReturns a result indicating success.
1.3 to 1.XReturns nn::fs::ResultOperationDenied.
2.0 ~ 2.2Returns nn::fs::ResultAccessDenied.
2.3 and later versionsReturns nn::fs::ResultOperationDenied.

CTR-SDK 1.2 and earlier versions return a result indicating success, but the double mounting of save data is not supported. Never perform double mounting because the save data could become corrupted when overwriting.

Revision History

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