#include <cafe/fs.h> FSStatus FSRemove( FSClient *client, FSCmdBlock *block, const char *path, FSRetFlag errHandling ); FSStatus FSRemoveAsync( FSClient *client, FSCmdBlock *block, const char *path, FSRetFlag errHandling, const FSAsyncParams *asyncParams );
|client||Pointer to the client buffer.|
|path||File or directory path to be removed. Length must be less than
|errHandling||Auto error handling flag. Only indicated errors are returned.|
|asyncParams||(Async API only) Notification parameters for an asynchronous call.|
||The command was canceled.|
||Any file or directory entries exist in the target (directory only).|
||Target not found.|
||Specified path includes a file entry as directory.|
||Could not access to specified path.|
||The caller does not have correct access permission.|
||There is one or more open file or directory in the specified path.|
||Associated file system does not support this function.|
||Data space cannot be allocated to update directory tree.|
||Journaling space is full and new journaling block cannot be allocated.|
||(Only for manually mounted devices) Media is not present.|
||(Only for manually mounted devices) Media is in some inaccessible condition.|
||(Only for manually mounted devices) The data is corrupted beyond repair. The volume needs format.|
||(Only for manually mounted devices) Media is write protected.|
||Successfully issued request.|
||The argument is invalid.|
Removes the file or directory entry designated by path. It cannot be performed, and returns
FS_STATUS_ALREADY_OPEN, if path specifies opened entry.
It also cannot be performed, and returns
FS_STATUS_EXISTS, if any file or directory is included in the target directory.
Both a sync and async style API are provided. To use the async API, set the user callback and parameters in asyncParams.
For more information, see
|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.|
2014/09/16 Added "Thread that displays graphics" and "Thread that handles system messages" to "Do not call from".
2013/06/06 Added FS_STATUS_NOT_DIR and FS_STATUS_ACCESS_ERROR to return values.
2013/05/23 Added FS_STATUS_DATA_CORRUPTED to return values.
2013/05/20 Added FS_STATUS_MEDIA_NOT_READY and FS_STATUS_WRITE_PROTECTED to return values.
2013/05/08 Automated cleanup pass.
2013/01/10 Added "Callback" to "Do not call from".
2012/10/29 Added result "FS_STATUS_EXISTS".
2012/07/20 Readability and correctness cleanup.
2012/02/27 Initial version.
2010/03/30 Fixed type name FSNotificationParams ->