nn::fs::CreateArchiveAlias Function

Syntax

Result CreateArchiveAlias(
     const char * aliasArchiveName,
     const char * srcArchiveName
);

Parameters

Name Description
in aliasArchiveName Specifies the archive name that serves as an alias.
in srcArchiveName Specifies the name of the mounted archive that is the original source to which the alias refers.

Return Values

Returns the result of the operation.
Value Description
Result::IsSuccess Process was successful.
ResultNotFound The specified archive has not been mounted. You must not allow this error to occur in retail products.
Any other value. An application bug or some other unexpected error.

Description

Enables an archive to be accessed using a different archive name.

Allows the already-mounted archived named srcArchiveName to be accessed using the different archive name aliasArchiveName.

After you are finished using the alias, call the Unmount function with aliasArchiveName specified for its argument. Do not call the Unmount function while you are using the alias for the mounted archive named srcArchiveName.

Generally speaking, this function is used for development purposes. For example, if you have an archive that ultimately will be divided into two pieces, but for the sake of convenience want to operate as a single archive during development, you can use this function to create an alias for the single mounted archive so it can be accessed with two different archive names. There will be less changes that need to made to the final source code.

Revision History

2012/04/13
Initial version.

CONFIDENTIAL