FSUnmount

Syntax

#include <cafe/fs.h>

FSStatus FSUnmount(
                FSClient                        *client,
                FSCmdBlock                      *block,
                const char                      *target,
                FSRetFlag                       errHandling
                );
FSStatus FSUnmountAsync(
                FSClient                        *client,
                FSCmdBlock                      *block,
                const char                      *target,
                FSRetFlag                       errHandling,
                const FSAsyncParams             *asyncParams
                );

Parameters

client Pointer to the client buffer.
block Command block.
target Target mount point path.
errHandling Auto error handling flag. Only indicated errors are 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 done.
FS_STATUS_CANCELED The command was canceled.
FS_STATUS_NOT_FOUND Target was not found.
FS_STATUS_MEDIA_ERROR The media is in some inaccessible condition.

Async API: Immediate return values

FS_STATUS_OK Successfully issued the request.
FS_STATUS_FATAL_ERROR The argument was invalid.

Description

Unmount the volume designated by mount path target.

All then open file handles and directory handles in the volume will be closed automatically.

NOTE:
You will not be able to return to the application if you close the handle after unmounting.

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

Do Not Call From

FSUnmount

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.

FSUnmountAsync

None.

See Also

Mount
FSMount
FSGetMountSource
FSGetMountSourceNext

Revision History

2014/09/16 Added "Thread that displays graphics" and "Thread that handles system messages" to "Do not call from".
2013/05/08 Automated cleanup pass.
2013/04/19 Added information about close file/directory handle.
2013/01/10 Added "Callback" to "Do not call from".
2012/07/19 Readability cleanup.
2010/12/06 Initial version.
2010/03/30 Fixed type name FSNotificationParams -> FSAsyncParams.


CONFIDENTIAL