EOS_Metrics_EndPlayerSession

EOS API reference page for EOS_Metrics_EndPlayerSession

Choose your implementation method:

C

C#

This function is part of the Metrics Interface.

Remarks

Logs the end of a game session for a local player. Call once when the game client leaves the active game session. Each call to BeginPlayerSession must be matched with a corresponding call to EndPlayerSession.

Return Value

Returns EOS_Success on success, or an error code if the input parameters are invalid or there was no active session for the player.

Parameters

EOS_Metrics_EndPlayerSession

Parameter Type And Name

Usage Information

EOS_HMetrics Handle

const EOS_Metrics_EndPlayerSessionOptions* Options

Structure containing the account id of the player whose session to end.

Related API Members

This function is part of the Metrics Interface.

Remarks

Logs the end of a game session for a local player. Call once when the game client leaves the active game session. Each call to BeginPlayerSession must be matched with a corresponding call to EndPlayerSession.

Return Value

Returns {Result.Success} on success, or an error code if the input parameters are invalid or there was no active session for the player.

Parameters

Metrics.MetricsInterface.EndPlayerSession

Parameter Type And Name

Usage Information

EndPlayerSessionOptions options

Structure containing the account id of the player whose session to end.

Related API Members