DWC_RegisterMatchStatus

Syntax

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

Arguments

None.

Return Values

TRUE Matchmaking status is registered with the matchmaking server.
FALSE Matchmaking status is not registered because of a failure to log on or an error.

Description

Registers the local host's own matchmaking information (or "matchmaking status") in the matchmaking server. For at least 15 seconds after this function is called, other hosts who have accessed the matchmaking server can see the status of the local host and can proceed to matchmaking with it.

Because with peer matchmaking this matchmaking status registration is carried out inside the matchmaking start functions (DWC_ConnectToAnybodyAsync and DWC_ConnectToFriendsAsync), calling this function in peer matchmaking is unnecessary. However, because this matchmaking status is erased from the matchmaking server when matchmaking ends or is canceled, another 15-second wait is required when matchmaking is started again. To decrease this wait time as much as possible, call this function at an appropriate time before starting matchmaking.

For example, call this function after peer matchmaking has completed, one game has been played, and the selection has been made to continue the game.

The matchmaking status is also erased when DWC_ShutdownFriendsMatch is called. The library registers the matchmaking status when the connection to Wi-Fi Connection completes, which allows for a quick completion of the first matchmaking after a connection to the Wi-Fi Connection is established.

For server-client matchmaking, matchmaking status registration is conducted inside the matchmaking start functions (DWC_SetupGameServer and DWC_ConnectToGameServerAsync) in the same way as in peer matchmaking. However, the matchmaking status is not deleted until the DWC_ShutdownFriendsMatch function is called. Therefore, there is no need to call this function.

Revision History

For the changelog prior to 5.1 PR2, click here.


CONFIDENTIAL