WM_SetParentParameter

Syntax

#include <nitro/wm.h>

WMErrCode WM_SetParentParameter( WMCallbackFunc callback , const WMParentParam* pparaBuf );

Arguments

callback Designates the callback function to call when the asynchronous process completes. This callback is called from within the interrupt handler.
pparaBuf Pointer to the structure that shows parent information. Note that the pparaBuf and pparaBuf→userGameInfo entities are forcibly cached.

Return Values

Returns the results of the WMErrCode enumerated type process.

Description

Sets the parameters that are required for a parent This API must be executed once before the WM_StartParent is called. This function is only executable when the WM is in the IDLE state. If the return value is WM_ERRCODE_OPERATING, a callback is generated after the parameter setting process is complete.

Notes

The pparaBuf and pparaBuf→userGameInfo data is forcibly stored in the internal cache. To avoid overwriting surrounding memory regions, be sure to pass data that is 32-byte aligned.
See the Wireless Communication Library Manual (AboutWirelessManager.pdf) for additional details.

See Also

WM_StartParent
WM_EndParent
WM_SetGameInfo

Revision History

2008/12/17 Added a note about how data passed in arguments is forcibly cached internally.
2005/06/08 Added the fact that the callback is called from the interrupt handler.
2004/10/22 Changed the type of return values.
2004/08/02 Standardized structure names.
2004/07/29 Added to Description.
2004/07/23 Initial version.


CONFIDENTIAL