nn::nex::MatchMakingClient::UpdateSessionHost Member Function

Syntax

qBool UpdateSessionHost(
     ProtocolCallContext * pContext,
     GatheringID gid,
     qBool isMigrateOwner = false
);

Parameters

Name Description
in pContext Call information.
in gid ID of the gathering to change.
in isMigrateOwner Specifies whether to change the gathering owner to the caller, at the same time.

Return Values



Value Description
true Call initialization succeeded.
false Failure.

Description

Changes the gathering host.

The host of the specified gathering is changed to the user that called this function. This function can only be called by gathering participants. If the options are configured such that the GatheringFlags::ChangeOwnerByOtherHost flag is set in flags of the Gathering object, the owner can be changed at the same time. If the owner is changed, NotificationEvents::OwnershipChangeEvent will be notified 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): Not participating in the gathering.
QERROR(RendezVous, InvalidOperation): The isMigrateOwner parameter was set to true, but the owner could not be changed because the GatheringFlagsChangeOwnerByOtherHost flag is not set.

See Also

HostMigrationExtension
GatheringFlags

Revision History

2014/03/11
Revised the function so that the application can specify whether to change the gathering owner to the caller, at the same time. The function previously returned QERROR(RendezVous, SessionVoid) when called on a gathering where the local station is not a participant, but now it returns QERROR(RendezVous, PermissionDenied).
2013/04/04
Revised to return QERROR(RendezVous, SessionVoid) when a nonexistent gathering has been specified.
2011/01/27
Initial version.

CONFIDENTIAL