FSAsyncParams

Syntax

#include <cafe/fs.h>

typedef struct
{
    FSAsyncCallback         userCallback;
    void                    *userContext;
    OSMessageQueue*         ioMsgQueue;
} FSAsyncParams;

Elements

userCallback Pointer to the user callback function.
userContext User parameter. This is passed to the callback function or message queue as is.
ioMsgQueue Pointer to the message queue.

Description

Notification parameter structure for an asynchronous call.

When an asynchronous API which was called with FSAsyncParams completes, userCallback is invoked or the notification message (FSMessage) is returned to ioMsgQueue. The specified userContext is passed to userCallback or to ioMsgQueue. FSGetAsyncResult retrieves asynchronous results from the notification message.

The callback function and user message queue are mutually exclusive. Only one of userCallback and ioMsgQueue may be non-null and the other must be null.

NOTE:
FS_STATUS_FATAL_ERROR may return to the callback when handling FAT.

See Also

FSAsyncCallback
Types / Structures
FSStatus
FSGetAsyncResult

Revision History

2013-05-30 Move FSAsyncCallback to its own page.
2013-05-08 Automated cleanup pass.
2013-04-15 Fixed Description.
2012-07-20 Readability cleanup.
2012-04-10 Fixed Description.
2011-12-13 Initial version.


CONFIDENTIAL