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 function cancels the matchmaking in progress.

The cancel process completes inside this function, and a matching completion callback function (DWCMatchedSCCallback) is called. When that happens, the cancel argument of the callback function is TRUE.

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

Only use this function 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.

Revision History

2.0.0
Added a Note directing to only use this function when the local host has not yet connected to anyone else.
2.0.0
Removed the description of DWCMatchedCallback.

CONFIDENTIAL