WFS_RequestClientRead

Syntax

#include <nitro/wfs.h>

void WFS_RequestClientRead(WFSClientContext *context, void *buffer, u32 offset, u32 length, WFSRequestClientReadDoneCallback callback, void *arg);

Arguments

context Pointer to the WFSClientContext structure.
buffer Memory buffer for storing the data that is read.
offset Address of the data to read within the device.
length Data size to read.
callback Read completion callback in WFSRequestClientReadDoneCallback format.
Specify NULL if not needed.
arg Optional argument passed to the read completion callback.

Return Values

None.

Description

Issues a ROM image read request to the parent (server). Block transfer is automatically executed within the library using a subsequent MP communication hook function.
If the request completes or WFS_EndClient is called when the request is being processed, notification will be made using a completion callback in WFSRequestClientReadDoneCallback format.

This function cannot be used until client preparations are complete and WFS_EVENT_CLIENT_READY event notification has been issued. Furthermore, this function cannot be called again until the previous request has been completed.

Use WFS_GetClientReadProgress to check the current status of a request.

See Also

WFSEventCallback, WFSEventType,
WFS_GetClientReadProgress

Revision History

2007/06/11 Added argument.
2007/06/06 Initial version.


CONFIDENTIAL