void SetTargetGatheringId( const qList< GatheringID > & targetGids );
Name | Description | |
---|---|---|
in | targetGids | Returns the search criteria for the matchmaking session. Up to two can be specified. |
Sets the gathering ID that the user wants to join.
Joins the matchmaking session (gathering) with the specified gathering ID. You can specify multiple gathering IDs, and the function attempts to join them in the order they are listed. When the MatchmakeExtensionClient::AutoMatchmake function is called after using this function, the last three matchmaking sessions to be joined are not excluded from the list of eligible matchmaking sessions. Applications are allowed to use this function to join or create a matchmaking session after they have used the MatchmakeExtensionClient::BrowseMatchmakeSession
function to search for sessions and filter the results. Note that in most cases you can achieve the same result by using the MatchmakeExtensionClient::AutoMatchmake
function, which allows you to specify search conditions by appropriately specifying MatchmakeSessionSearchCriteria
. First, consider using the AutoMatchmakeParam::SetSearchCriteria
function, which allows you to specify search conditions.
If you are also going to use this function, we strongly recommend that you implement code in such a way that matchmaking sessions are not unnecessarily created because the matchmaking session could not be joined (or another reason), and also so that multiple gathering IDs can be specified and the order of the list differs as much as possible for each client. If none of the matchmaking sessions can be joined, a matchmaking session is created using the parameters specified with the AutoMatchmakeParamSetSourceMatchmakeSession
function. This function and AutoMatchmakeParam::SetSearchCriteria
are mutually exclusive. You cannot set both. The initial state is empty.
CONFIDENTIAL