nn::nex::MatchMakingClient::EndParticipation Member Function

Syntax

qBool EndParticipation(
     ProtocolCallContext * pContext,
     GatheringID id,
     const String & strMessage = _T("")
);

Parameters

Name Description
in pContext Call information.
in id ID of the gathering to be left.
in strMessage Returns the message that notifies the gathering owner or participants. The maximum string length is given by MATCHMAKE_STRING_MAX_LENGTH.

Return Values



Value Description
true Call initialization succeeded.
false Failure.

Description

Withdraws from a gathering (matchmaking session).

Withdraws from the gathering with the specified ID. If there are no participants in the gathering, the gathering is automatically deleted.

The following results may be returned as a result of asynchronous operation. Use the application to handle these results.

QERROR(RendezVous, SessionVoid): The gathering does not exist.
QERROR(RendezVous, PermissionDenied): Not a participant in the gathering.
QERROR(Core, InvalidArgument): The send data size restriction has been exceeded.

Revision History

2014/03/28
Previously, the function returned QERROR(RendezVous, SessionVoid) when called on a gathering where the local station was not a participant, but now it returns QERROR(RendezVous, PermissionDenied).
2011/01/27
Initial version.

CONFIDENTIAL