WM_SetGameInfo

C Specification

#include <nitro/wm.h>

WMErrCode WM_SetGameInfo(
WMCallbackFunc  callback ,
const u16*      gameInfo ,
u16             gameInfoSize ,
u32             ggid,
u16             tgid,
u8              attr
);

Arguments

callback Designates the callback function to call when the asynchronous process completes. This callback is called from within the interrupt handler.
gameInfo Specifies a pointer to user game information. Note that the data entity will be forcibly cached.
gameInfoSize Specifies the size of user game information. A maximum of 112 bytes can be specified.
ggid Specifies the game group ID.
tgid Specifies a temporary group ID.
attr Specifies attributes such as: receiving entry and DS download play permitted.

Return Values

Returns the results of the WMErrCode enumerated type process.

Description

Reconfigures the game-specific information sent out by the beacon. This function can be executed only if the WM is in the PARENT or MP_PARENT state. If the return value is WM_ERRCODE_OPERATING, a callback is generated after the information reconfiguration process is complete. While WM_SetParentParameter sets initial values, you can use this function to modify the values.

The argument attr is expressed as the logical sum of the following:

WM_ATTR_FLAG_ENTRY "Receiving entry" flag
WM_ATTR_FLAG_MB "Download play possible" flag
WM_ATTR_FLAG_KS Key sharing.Not currently used. (Note: Be sure to disable this bit.)
WM_ATTR_FLAG_CS Continuation communication mode. Not currently used.

See Also

WM_SetParentParameter, WM_StartParent

Revision History

12/08/2005 Deleted the description about key sharing.
06/08/2005 Added statement about callbacks being called from the interrupt handler.
10/22/2004 Changed return value type.
09/24/2004 Added to and revised Description.
08/02/2004 Standardized structure names.
07/29/2004 Added to Description.
07/23/2004 Initial version.