qBool CloseParticipation( ProtocolCallContext * pContext, GatheringID gid );
Name | Description | |
---|---|---|
in | pContext | Call information. |
in | gid | The ID of the matchmaking session to close participation for. |
Value | Description |
---|---|
true |
Call initialization succeeded. |
false |
Failure. |
Closes participation in a matchmaking session.
This function closes participation in the specified matchmaking session. Only the owner of the matchmaking session can do this. Depending on the timing, note that participation may be possible even after this RMC call succeeds.
If the asynchronous process succeeds, the participation status flag for the MatchmakeSession
object, which can be obtained by BrowseMatchmakeSession
or similar functions, is false
. (This flag can be also obtained by the MatchmakeSession::GetOpenParticipation
function.)
The following results may be returned as a result of asynchronous operation. Use the application to handle these results.
QERROR(RendezVous, SessionVoid)
: The matchmaking session does not exist.
: The caller is not the owner.
QERROR(RendezVous, PermissionDenied)
QERROR(RendezVous, PermissionDenied)
instead of success without doing anything when it is called by a station that is not the owner of the matchmaking session.false
when the asynchronous process succeeds.CONFIDENTIAL