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 to a callback that is called upon completion of the suspend process. A callback must be specified. This function does nothing if NULL is specified.
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 status of new participants during matchmaking.

After this function succeeds, the suspend process is executed inside subsequent calls to the DWC_ProcessFriendsMatch function. Once the suspend process has finished, the function specified by callback is 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 the same request is made on all of the hosts.

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

See Also

DWC_GetSuspendMatch

Revision History

For the changelog prior to 5.1 PR2, click here.


CONFIDENTIAL