qBool UnregisterGathering( ProtocolCallContext * pContext, GatheringID idGathering );
Name | Description | |
---|---|---|
in | pContext | Call information. |
in | idGathering | ID of the gathering to be deleted. |
Value | Description |
---|---|
true | Call initialization succeeded. |
false | Failure. |
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.
QERROR(RendezVous, PermissionDenied)
to occur.QERROR(RendezVous, SessionVoid)
when called on a gathering where the local station is not the owner, but it now returns QERROR(RendezVous, PermissionDenied)
.CONFIDENTIAL