WM_EndMP

C Specification

#include <nitro/wm.h>

WMErrCode WM_EndMP( WMCallbackFunc callback );

Arguments

callback Designates the callback function to call when the asynchronous process completes. This callback is called from within the interrupt handler.

Return Values

Returns the results of the WMErrCode enumerated type process.

Description

Ends the MP mode This function is executable only when the WM state is in either the MP_PARENT or MP_CHILD state. If the return value for the API is WM_ERRCODE_OPERATING, a callback is generated after the MP mode termination process is complete. The WM state goes back to its original PARENT or CHILD state.

When a child that performs MP communication calls the WM_EndMP function, the parent returns NULL for the communication from then on. When this status exceeds the MP communication lifetime set with the WM_SetLifeTime function, the child is disconnected from the parent. Note that when data is sent from a parent to the child in this condition by MP communication, the parent receives the send successful notice, but the child discards all the received data.

See Also

WM_StartMP, WM_StartMPEx, WM_SetMPDataToPort, WM_SetPortCallback

Revision History

06/08/2005 Added statement about callback being called from the interrupt handler.
11/09/2004 Added description about NULL reply.
10/22/2004 Changed type of return value.
09/25/2004 Added to and revised description.
07/29/2004 Added to Description
07/23/2004 Initial version