nn::nex::MatchMakingClient::GetDetailedParticipants Member Function

Syntax

qBool GetDetailedParticipants(
     ProtocolCallContext * pContext,
     GatheringID id,
     qList< ParticipantDetails > * pParticipants,
     qBool bOnlyActive = true
);

Parameters

Name Description
in pContext Call information.
in id The gathering ID whose detailed information is to be obtained.
out pParticipants Detailed information on participants.
in bOnlyActive Indicates whether only information about participating users can be obtained at this point.

Return Values



Value Description
true Call initialization succeeded.
false Failure.

Description

Gets the participant information of a gathering.

Gets information about the gathering participants with the specified ID. The participant's principal ID and the participant's principal ID converted into a string, in addition to the strings given by the MatchmakeExtensionClient::CreateMatchmakeSession, MatchmakeExtensionClient::JoinMatchmakeSession, MatchmakeExtensionClient::AutoMatchmake, and EndParticipation functions can be set in ParticipantDetails obtainable by this function. This function is not applicable to gatherings if the maximum number of participants is 0 (no limit) or if it exceeds 128 participants.

QERROR(Core, InvalidArgment) : The specified gathering has a maximum number of participants of 0 (no limit) or exceeds 128 participants.

Revision History

2011/01/27
Initial version.

CONFIDENTIAL