nn::nex::MatchmakeSessionSearchCriteria::SetVacantOnly Member Function

Syntax

qBool SetVacantOnly(
     bool vacantOnly,
     qUnsignedInt16 participants
);

Parameters

Name Description
in vacantOnly Specify true when excluding full sessions, and false when not excluding them.
in participants The number of vacancies. Specify a value of 1 or greater. This value is ignored if you specify false for vacantOnly.

Return Values



Value Description
true Settings were configured successfully.
false Failure. This function fails if you specify true for vacantOnly and 0 for participants.

Description

Sets whether to exclude full sessions. You can specify the number of vacancies to search for.

Sets whether to exclude full sessions. The default is not to exclude. If full sessions are excluded, you can specify the number of vacancies to look for when searching matchmaking sessions.

The MatchmakeExtensionClient::BrowseMatchmakeSession function then searches for matchmaking sessions with at least as many vacancies at the value you specified for participants.

If you specify search criteria using the AutoMatchmakeParam::SetSearchCriteria function, the MatchmakeExtensionClient::BrowseMatchmakeSession function searches for matchmaking sessions with at least as many vacancies as the number of users that will be joining the session regardless of the values set here.

Revision History

2014/09/16
Initial version.

CONFIDENTIAL