WM_Disconnect

C Specification

#include <nitro/wm.h>

WMErrCode WM_Disconnect( WMCallbackFunc callback , u16 aid );

Arguments

callback Designates the callback function to call when the asynchronous process completes. This callback is called from within the interrupt handler.
aid Specifies the AID of the communications party to disconnect. A parent can specify a value from 1 to 15. The child that is allocated the corresponding AID will be disconnected. A child machine should specify 0 (the parent's AID).

Return Values

Returns the results of the WMErrCode enumerated type process.

Description

Disconnects from a specified system This function is executable when the WM is connected (in the PARENT, MP PARENT, CHILD, MP CHILD, and DCF CHILD states). If the return value for the API is WM_ERRCODE_OPERATING, a callback is generated after the disconnection process is complete. When a child is disconnected, the communication is terminated and the WM goes back to the IDLE state. For a parent, only the specified child is disconnected. The communication to any other children will continue.

See Also

WM_StartParent, WM_StartConnect, WM_DisconnectChildren

Revision History

06/08/2005 Added statement about callbacks being called from the interrupt handler.
03/22/2005 Added description of aid argument.
10/22/2004 Changed return value type.
07/29/2004 Added to Description
07/23/2004 Initial version