DWC_CancelMatch

Syntax

#include <dwc.h>
BOOL DWC_CancelMatch(void);

Arguments

None.

Return Values

TRUE The cancel process succeeded.
FALSE An error is being generated or execution is impossible because matchmaking is not in progress or cancellation is already under way.

Description

This is deprecated. The functionality of the DWC_CancelMatch function has been merged with the DWC_CloseAllConnectionsHard function.

Cancels the matchmaking in progress.

The cancel process completes inside this function, and the matchmaking completion callback (DWCMatchedSCCallback) is called. In this case, the cancel argument of the callback function is TRUE.

To check simply whether cancellation is possible, use the DWC_IsValidCancelMatch function.

Use this function only when the local host has not connected to anyone else yet. Use the DWC_CloseAllConnectionsHard function when the local host has connected to someone even once.

This function was kept for compatibility with previous versions. Under the current version, the capabilities of this function have been integrated with the DWC_CloseAllConnectionsHard function, so be sure to call DWC_CloseAllConnectionsHard.

Revision History

For the changelog prior to 5.1 PR2, click here.


CONFIDENTIAL