WM_SetMPFrequency


C Specification

#include <nitro/wm.h>

WMErrCode WM_SetMPFrequency(
        WMCallbackFunc  callback , 
        u16             mpFreq );

Description

Sets the MP communications frequency

This function is only executable when the WM is in the MP_PARENT state.

This function is used during MP communications to dynamically change the communications frequency that was set by the mpFreq argument in WM_StartMP. If the return value is WM_ERRCODE_OPERATING, a callback will be generated after the MP data send process completes.

Arguments

callback Pointer to the callback function that is called when the asynchronous process completes.
mpFreq Specifies how many times to perform MP communications in one frame. When a value of 0 is specified, this function is set to the continuous packet send mode that is used for large volume data communication.

Return Values

Returns the process result as a WMErrCode enumerated type.

See Also

WM_StartMP, WM_SetMPDataToPort

Revision History

10/22/2004 Changed return value type
09/13/2004 Initial version