WM_Disconnect


C Specification

#include <nitro/wm.h>

WMErrCode WM_Disconnect ( 
    WMCallbackFunc    callback , 
    u16               aid );

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.

Arguments

callback Specifies the callback function to call when an asynchronous process completes.
aid Specifies the AID of the communications party to disconnect. A parent individually disconnects ID 1-15 children. A child machine terminates communication with the parent (ID=0).

Return Values

Returns the process result as a WMErrCode enumeration type.

See Also

WM_StartParent, WM_StartConnect, WM_DisconnectChildren

Revision History

10/22/2004 Changed return value types
07/29/2004 Added descriptions
07/23/2004 Initial version