nn::nex::MatchMakingClient::UnregisterGathering Member Function

Syntax

qBool UnregisterGathering(
     ProtocolCallContext * pContext,
     GatheringID idGathering
);

Parameters

Name Description
in pContext Call information.
in idGathering ID of the gathering to be deleted.

Return Values



Value Description
true Call initialization succeeded.
false Failure.

Description

Deletes a gathering from the game server.

The gathering with the specified ID is deleted from the game server. Only the gathering owner can execute this function. If asynchronous processing succeeds, a NotificationEvents::GatheringUnregistered event is sent to all participants in the gathering.

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): The caller is not the owner.
Or, attempted to delete the official persistent gathering.

Revision History

2014/09/02
The function now fails if you attempt to delete the official persistent gathering. Added that attempting to delete the official persistent gathering causes QERROR(RendezVous, PermissionDenied) to occur.
2014/03/28
The function previously returned QERROR(RendezVous, SessionVoid) when called on a gathering where the local station is not the owner, but it now returns QERROR(RendezVous, PermissionDenied).
2011/01/27
Initial version.

CONFIDENTIAL