DWC_RequestSuspendMatchAsync

Syntax

#include <dwc.h>

BOOL DWC_RequestSuspendMatchAsync(BOOL suspend,
                                  DWCSuspendCallback callback,
                                  void *data);

Arguments

suspend TRUE: Sets the acceptance denied state.
FALSE: Sets the acceptance permitted state.
callback DWCSuspendCallback-type function pointer that is called upon completion of the suspend process.
data Arbitrary data passed to callback.

Return Values

TRUE Successfully accepted the suspension state change request.
FALSE Was not in a state to accept suspension state change requests.

Description

Starts the processing to change the acceptance state of new participants during matchmaking.

After this function succeeds, the suspend process will be executed within subsequent calls to the DWC_ProcessFriendsMatch function. Once the suspend process has finished, the function specified by callback will be invoked. When you use suspend processing, have all hosts call this function (DWC_RequestSuspendMatchAsync) at the same time. The acceptance state will not change until all of the hosts call this function.

This function will return FALSE when it has already been called once successfully but the suspend process has not yet completed.

See Also

DWC_GetSuspendMatch

Revision History

2.0.1
Added a statement that the acceptance state is only changed after all of the hosts call this function.
2.0.0
Initial addition.

CONFIDENTIAL