FSRollbackQuota

Syntax

#include <cafe/fs.h>

FSStatus FSRollbackQuota(
                FSClient                        *client,
                FSCmdBlock                      *block,
                const char                      *path,
                FSRetFlag                       errHandling
                );
FSStatus FSRollbackQuotaAsync(
                FSClient                        *client,
                FSCmdBlock                      *block,
                const char                      *path,
                FSRetFlag                       errHandling,
                const FSAsyncParams             *asyncParams
                );

Parameters

client Pointer to the client buffer.
block Command block.
path Path specifying the quota. Its length must be less than FS_MAX_ARGPATH_SIZE.
errHandling Auto error handling flag. Only the indicated error is returned.
asyncParams (Async API only) Notification parameters for an asynchronous call.

Return Values

Sync API : Return values / Async API: Callback return values

FS_STATUS_OK Successfully completed.
FS_STATUS_CANCELED The command was canceled.
FS_STATUS_NOT_FOUND Target not found.
FS_STATUS_ALREADY_OPEN There is one or more open file or directory in the quota.
FS_STATUS_UNSUPPORTED_CMD The associated file system does not support this function.
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 must be reformatted.

Async API: Immediate return values

FS_STATUS_OK Successfully issued request.
FS_STATUS_FATAL_ERROR The argument is invalid.

Description

Rolls back the quota designated by path to its previous state. The quota is a type of directory that has an upper data size limit. The updated data can be flushed for each quota unit. Application save data is created as a quota.

All operations by the FS API are temporarily recorded to a transaction by the journaling feature. All operations in the transaction become effective immediately by calling FSFlushQuota.

If this function is called or a sudden shutdown occurs, all data in the transaction becomes void. The volume data is then rewound to the previous flushed state when the volume is mounted again.

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

This function is for only file systems supporting the journaling feature. On other file systems, this function returns the error FS_STATUS_UNSUPPORTED_CMD.

Do Not Call From

FSRollbackQuota

Thread that displays graphics Do not call this function from a thread that displays graphics. This function may block indefinitely in error cases and the application must be able to display appropriate messages.
Thread that handles system messages Do not call this function from a thread that handles system messages. This function may block indefinitely in error cases and the application must be able to handle system events such as shutdown.
Callbacks Do not call this function from any callback function.
Interrupt handler Do not call this function from any interrupt handler.
Exception handler Do not call this function from any exception handler.

FSRollbackQuotaAsync

None.

Revision History

2014/09/16 Added "Thread that displays graphics" and "Thread that handles system messages" to "Do not call from".
2013/05/23 Added FS_STATUS_DATA_CORRUPTED to return values.
2013/05/20 Added FS_STATUS_MEDIA_NOT_READY to return values.
2013/05/08 Automated cleanup pass.
2013/01/10 Added "Callback" to "Do not call from".
2012/07/20 Readability cleanup.
2012/02/27 Initial version.
2010/03/30 Fixed type name FSNotificationParams -> FSAsyncParams.


CONFIDENTIAL