nn::fs::Unmount Function

Syntax

Result Unmount(
     const char * archiveName
);

Arguments

Name Description
in archiveName Specifies the archive name.

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.
ResultNotFound The specified archive has not been mounted. You must not allow this error to occur in retail products.
A value other than the above. An application bug or some other unexpected error.

Description

Unmounts an archive.

Call this function to unmount a region when a mounted archive is no longer necessary.

If you have enabled automatic redundancy for save data, do not forget to call the CommitSaveData function before unmounting.

Before you unmount an archive, call Finalize on all files and directories that open from it. If you have written to a file without calling Flush, do not forget to call Flush when you close the file.

Revision History

2010/12/14
Added return values.
2010/12/10
Added a note about Finalize for files and directories during unmount operations.
2010/11/13
Added cautions for unmounting.
2010/08/16
Initial version.

CONFIDENTIAL