WPADWriteGameData

C Specification

#include <revolution/wpad.h>

#define WPAD_CHAN0                    0
#define WPAD_CHAN1                    1
#define WPAD_CHAN2                    2
#define WPAD_CHAN3                    3

#define WPAD_MEM_GAMEDATA_LEN         3888

s32 WPADWriteGameData( s32 chan, void *p_buf, u16 len, u16 offset, WPADCallback callback );

Arguments

`chan`	One of the `WPAD_CHANn` values.
`p_buf`	The starting address of the data to be saved.
`len`	Size of the data to be saved.
`offset`	The offset from the ending address of the game data's file information (the starting address for where game data can be actually written) to the starting address for the write process.
`callback`	Callback function to report on the result.

Return Values

Returns one of the following codes:

WPAD_ERR_NONE
WPAD_ERR_NO_CONTROLLER
WPAD_ERR_BUSY

Description

Writes data to the Wii Remote memory at the specified channel. This function registers the command used to read data to the library. The WPAD library processes registered commands when other commands are not running.

For saving game data, 4000 bytes are allocated within the internal memory, but the first 112 bytes are used by the library to manage file information. Even though an application can only save game data to the 3888 bytes from the 112th to the 4000th byte, the 112th byte has an offset value of 0 within the library so there is no need to be particularly aware of it.

The game title set with the WPADSetGameTitleUtf16 function and the date and time when the file was saved are stored in the file information. The game title can be obtained with the WPADGetGameTitleUtf16 function, and the date and time can be obtained with the WPADGetGameDataTimeStamp function.

Error Codes

The return values have the following meanings:

`WPAD_ERR_NONE`	The WPAD library received a command.
`WPAD_ERR_BUSY`	The WPAD library was unable to receive a command.
`WPAD_ERR_NO_CONTROLLER`	The connection was broken.

Callbacks

In addition, if a callback function is set, the callback function returns the following error codes when the processing is complete. Their meanings are as follows:

`WPAD_ERR_NONE`	The command was processed normally.
`WPAD_ERR_BUSY`	The WPAD library was unable to receive a command. Call it again later.
`WPAD_ERR_TRANSFER`	A communications error prevented normal processing of the command.
`WPAD_ERR_NO_CONTROLLER`	The connection was broken.

Revision History

2007/02/08 Revised the description of offset.
2006/11/29 Added WPAD_ERR_BUSY, which had been left off the list, to the error codes passed by the callback.
2006/09/27 Added descriptions of WPADSetGameTitleUtf16 and WPADGetGameTitleUtf16.
2006/08/15 Initial version.