FSCloseDir

Syntax

#include <cafe/fs.h>

FSStatus FSCloseDir(
                FSClient                        *client,
                FSCmdBlock                      *block,
                FSDirHandle                     dirHandle,
                FSRetFlag                       errHandling
                );
FSStatus FSCloseDirAsync(
                FSClient                        *client,
                FSCmdBlock                      *block,
                FSDirHandle                     dirHandle,
                FSRetFlag                       errHandling,
                const FSAsyncParams             *asyncParams
                );

Parameters

client Pointer to the client buffer.
block Command block.
dirHandle directory handle.
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 completed.
FS_STATUS_CANCELED Command was canceled.
FS_STATUS_MEDIA_ERROR (Only for manually mounted devices) Media is in some inaccessible condition.

Async API: Immediate return values

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

Description

Closes the specified directory stream.

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

FSCloseDir

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.

FSCloseDirAsync

None.

See Also

File/Directory operations
FSOpenDir
FSReadDir
FSRewindDir

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/01/10 Added "Callback" to "Do not call from".
2012/07/19 Readability and correctness cleanup.
2012/02/20 Initial version.
2010/03/30 Fixed type name FSNotificationParams -> FSAsyncParams.


CONFIDENTIAL