nn::nex::MatchmakeExtensionClient::UpdateMatchmakeSession Member Function

Syntax

qBool UpdateMatchmakeSession(
     ProtocolCallContext * pContext,
     const GatheringHolder & matchmakingSession
);

Parameters

Name Description
in pContext Call information.
in matchmakingSession The matchmaking session to be updated.

Return Values



Value Description
true Call initialization succeeded.
false Failure.

Description

Updates a matchmaking session.

Nintendo recommends using the overload that takes UpdateMatchmakeSessionParam as an argument. Updates all of the data other than matchmaking session ID, owner, P2P communication host, gathering flags, communication key for P2P session, matchmaking system type, and related persistent gathering IDs. Only the owner of the matchmaking session can do this. Before calling this function, you must specify the gathering ID for the matchmaking session to update. This parameter is specified with the Gathering::SetID 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.
QERROR(RendezVous, PermissionDenied): The caller is not the owner.

Revision History

2014/10/02
Added that it is not possible to change the matchmaking system type and related persistent gathering IDs.
2014/06/23
Added that Nintendo recommends using the overload that takes UpdateMatchmakeSessionParam as an argument. Prevented changes to the matchmaking system type.
2014/03/28
Changed the function so that it returns 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.
2014/03/11
Added that the flags of the gathering are not updated.
2012/04/20
Listed that a gathering ID for the matchmaking session to change must be specified in the MatchmakeSession object provided in the arguments.
2011/01/27
Initial version.

CONFIDENTIAL