#include <cafe/fs.h> FSStatus FSOpenDir( FSClient *client, FSCmdBlock *block, const char *path, FSDirHandle *dirHandle, FSRetFlag errHandling ); FSStatus FSOpenDirAsync( FSClient *client, FSCmdBlock *block, const char *path, FSDirHandle *dirHandle, FSRetFlag errHandling, const FSAsyncParams *asyncParams );
|client||Pointer to the client buffer.|
|path||File path to open. Length must be less than
|dirHandle||Pointer to the handle of directory stream associated to the directory to be opened.|
|errHandling||Auto error handling flag. Only indicated errors are returned.|
|asyncParams||(Async API only) Notification parameters for an asynchronous call.|
||The command was canceled.|
||System has too many directory points to create more.|
||Target not found.|
||Specified path is not a directory.|
||The caller does not have correct access permission.|
||(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.|
||Successfully issued request.|
||The argument is invalid.|
Open directory designated by path and creates directory stream associated with it. Position of the directory stream is set to the head.
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
FSAsyncParams. The generated directory handle is stored in dirHandle when completed.
The generated directory handle is positive value (>0) if the function succeeds. Otherwise, the handle value is
FS_INVALID_HANDLE_VALUE. The invalid handle value is not necessary to close.
|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/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/03/18 Added description about the generated directory handle.
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 ->