SAVEGetStat / SAVEGetStatAsync

Syntax

#include <nn/save.h>

FSStatus            SAVEGetStat(
                        FSClient                *client,
                        FSCmdBlock              *block,
                        u8                      accountSlotNo,
                        const char              *path,
                        FSStat                  *returnedStat,
                        FSRetFlag               errHandling
                        );
FSStatus            SAVEGetStatAsync(
                        FSClient                *client,
                        FSCmdBlock              *block,
                        u8                      accountSlotNo,
                        const char              *path,
                        FSStat                  *returnedStat,
                        FSRetFlag               errHandling,
                        const FSAsyncParams     *asyncParams
                        );

Parameters

client Pointer to the client buffer.
block Command block.
accountSlotNo The user account slot number.
path File path to get status. The relative path for the save directory for the specified user account. The length must be less than FS_MAX_ARGPATH_SIZE.
returnedStat Pointer to status information.
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_NOT_FOUND Target not found.
or
The specified user account does not exist on this Wii U console.
FS_STATUS_PERMISSION_ERROR The caller does not have the 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.
FS_STATUS_FATAL_ERROR The argument is invalid.

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

Gets the status information of the file or directory specified in path. This is identical to some directory entries (see FSReadDir).

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.

For the sync API, the status information obtained is stored in returnedStat when the process is completed.

Do Not Call From

SAVEGetStat

None.

SAVEGetStatAsync

None.

See Also

File/Directory operations
FSStat
FSGetAsyncResult
SAVEGetFreeSpaceSize

Revision History

2014/10/22 Revised the return values.
2013/05/08 Automated cleanup pass.
2012/10/01 Revised the return values.
2012/06/25 Fixed a link in the See Also list.
2012/06/14 Corrected links.
2012/03/29 Initial version.


CONFIDENTIAL