WM_SetMPParameter 

Syntax

#include <nitro/wm.h>

WMErrCode WM_SetMPParameter(
        WMCallbackFunc  callback ,
        const WMMPParam* param
);

Arguments

callback Designates the callback function to call when the asynchronous process completes. This callback is called from within the interrupt handler.
param Pointer to the structure storing parameters used for MP communications.

Return Values

Returns the results of the WMErrCode enumerated type process.

Description

Sets various parameters used for MP communications. Although this function may be called any time after WM_Initialize, some parameters can only be set during certain communication states. Basically, this function is called to make detailed MP settings after a connection has been established by WM_StartParent or WM_StartConnect but before WM_StartMP is called. The values set using this function are enabled until a return to READY state. In other words, once a value is set with this function, that value will continue to be used if WM_StartMP is called sequentially, without WM returning to the READY state. However, settings specified as arguments to the WM_StartMP and WM_StartMPEx functions are temporarily overwritten during the MP_PARENT or MP_CHILD states that WM enters as a result of that function being called.

For details on parameters that can be set, see the WMMPParam structure.

See Also

WMMPParam, WM_StartMP, WM_StartMPEx, WM_SetParentParameter

Revision History

2007/05/02 Added a description of the active range of setting values.
2005/11/24 Initial version.


CONFIDENTIAL