FSChangeDir

Syntax

#include <cafe/fs.h>

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

Parameters

client Pointer to the client buffer.
block Command block.
path Directory path to change the current directory to. The length must be less than FS_MAX_ARGPATH_SIZE.
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 The command was canceled.

Async API: Immediate return values

FS_STATUS_OK Successfully issued request.
FS_STATUS_FATAL_ERROR The argument is invalid.

Description

Sets the current working directory to the directory designated by path. The existence of specified directory is not checked so you can specify a nonexistent 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 FSAsyncParams.

Do Not Call From

FSChangeDir

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.

FSChangeDirAsync

None.

See Also

Path space
FSGetCwd

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/20 Readability cleanup.
2012/02/27 Initial version.


CONFIDENTIAL