DWC_CloseConnectionHardBitmap

C Specification

#include <dwc.h>

int DWC_CloseConnectionHardBitmap( u32* bitmap );

Description

Forces the connection with the specified AID to close. Close process completes within this function. Each time a close operation for one AID is completed, the callback function set with the DWC_SetConnectionClosedCallback function is called before exiting this function.

The other host is also notified of this close, and the close callback DWCConnectionClosedCallback is called on the other host. However, because this close notification is only sent once by UDP communications, it is possible, depending on the conditions of the connection, that the notification will not reach its destination.

Use this function to handle unusual situations—for example, closing the connection of a host when communication has become impossible because the host has been turned off.

If you use the DWC_CloseConnectionHard function, you can specify an individual AID and close the connection.

Arguments

bitmap Provides a pointer to the region where the AID bitmap of the host to be closed is stored. After the close operation is completed, only the value (bitmap) created by the bit of the AID that actually closed successfully is stored and returned to the reference destination of this pointer. At that time, your own AID bit is always 0.

Return Values

0 Close operation complete
-1 No action taken because the connection has not been established or an error occurred.
-2 Did nothing since all the AIDs had already been closed.

See Also

DWC_CloseConnectionHard, DWC_CloseAllConnectionsHard, DWC_SetConnectionClosedCallback, DWCConnectionClosedCallback

Revision History

12/16/2005 Added detailed explanations of functions and arguments.
11/07/2005 Initial version