DWC_CloseConnectionHard

Syntax

#include <dwc.h>

int DWC_CloseConnectionHard( u8 aid );

Description

Forces the close of a connection whose AID is specified. The close process completes within this function. The callback function set with DWC_SetConnectionClosedCallback is called before this function exits.

It remains logged in to the Nintendo Wi-Fi Connection service.

The other host is notified of this closing, and the close callback DWCConnectionClosedCallback is called on that host. However, because this close notification is only sent once over UDP, the notification may not reach its destination due to the connection conditions.

Use this function to handle unusual situations, such as to close the connection of a host when communication has become impossible because the host has been turned off.

To close the connections to multiple AIDs, use the DWC_CloseConnectionHardBitmap function.

Arguments

aid AID of the host to close.

Return Values

0 Close operation complete.
-1 No action is taken because the connection to the Wi-Fi Connection service has not been established or an error has occurred.
-2 No action is taken because an already closed AID was specified.

See Also

DWC_CloseAllConnectionsHard
DWC_CloseConnectionHardBitmap
DWC_SetConnectionClosedCallback
DWCConnectionClosedCallback

Revision History

2005/12/16 Added a detailed function description.
2005/07/11 Initial version.


CONFIDENTIAL