SAVEOpenDir / SAVEOpenDirAsync

Syntax

#include <nn/save.h>

FSStatus            SAVEOpenDir(
                        FSClient                *client,
                        FSCmdBlock              *block,
                        u8                      accountSlotNo,
                        const char              *path,
                        FSDirHandle             *dirHandle,
                        FSRetFlag               errHandling
                        );
FSStatus            SAVEOpenDirAsync(
                        FSClient                *client,
                        FSCmdBlock              *block,
                        u8                      accountSlotNo,
                        const char              *path,
                        FSDirHandle             *dirHandle,
                        FSRetFlag               errHandling,
                        const FSAsyncParams     *asyncParams
                        );

Parameters

client Pointer to the client buffer.
block Command block.
accountSlotNo The user account slot number.
path Directory path. The relative path for the save directory for the specified user account. The length must be less than SAVE_MAX_ARGPATH_SIZE.
dirHandle Pointer to the handle of the directory stream associated with the directory to open.
errHandling Automatic error handling flag. Only the indicated error is returned.
asyncParams (Async API only) Notification parameters for an asynchronous call.

Return Values

Synchronous API: Return Value; Asynchronous API: Callback Return Value

FS_STATUS_OK Successfully completed.
FS_STATUS_CANCELED The command was canceled.
FS_STATUS_MAX System has too many directory points to create more.
FS_STATUS_NOT_FOUND Target not found.
or
The specified user account does not exist on this Wii U console.
FS_STATUS_NOT_DIR Specified path is not a directory.
FS_STATUS_PERMISSION_ERROR The caller does not have correct access permission.
FS_STATUS_MEDIA_NOT_READY (Only for manually mounted devices) Media is not present.
FS_STATUS_MEDIA_ERROR (Only for manually mounted devices) Media is in some inaccessible condition.
FS_STATUS_DATA_CORRUPTED (Only for manually mounted devices) The data is corrupted beyond repair. The volume needs format.

Async API: Immediate Return Values

FS_STATUS_OK Successfully issued the request.
FS_STATUS_NOT_FOUND The specified user account does not exist on this Wii U console.
FS_STATUS_FATAL_ERROR The argument is invalid.

Description

Opens the save subdirectory specified in path and creates the directory stream associated with that directory. The position of the directory stream is set to the head.

The generated directory handle is stored in dirHandle when the process is completed.

Both the sync and the async style API functions are provided. To use the async API functions, set the user callback and parameters in asyncParams. For more information, see FSAsyncParams.

Do Not Call From

SAVEOpenDir

None.

SAVEOpenDirAsync

None.

See Also

File/Directory operations
FSReadDir
FSRewindDir
FSCloseDir

Revision History

2014/10/22 Revised the return values.
2013/05/08 Automated cleanup pass.
2012/10/01 Revised the return values.
2012/06/14 Fixed an argument.
2012/03/29 Initial version.


CONFIDENTIAL