EOS_Sessions_RegisterPlayers

EOS API reference page for EOS_Sessions_RegisterPlayers

Choose your implementation method:

C

C#

This function is part of the Sessions Interface.

Remarks

Register a group of players with the session, allowing them to invite others or otherwise indicate they are part of the session for determining a full session

Return Value

  • EOS_Success if the register completes successfully

  • EOS_NoChange if the players to register registered previously

  • EOS_InvalidParameters if any of the options are incorrect

  • EOS_Sessions_OutOfSync if the session is out of sync and will be updated on the next connection with the backend

  • EOS_NotFound if a session to register players does not exist

Parameters

EOS_Sessions_RegisterPlayers

Parameter Type And Name

Usage Information

EOS_HSessions Handle

const EOS_Sessions_RegisterPlayersOptions* Options

Structure containing information about the session and players to be registered

void* ClientData

Arbitrary data that is passed back to you in the CompletionDelegate

const EOS_Sessions_OnRegisterPlayersCallback CompletionDelegate

A callback that is fired when the registration operation completes, either successfully or in error

This function is asynchronous; the EOS SDK guarantees that your callback (the CompletionDelegate parameter) will run when the operation completes, regardless of whether it succeeds or fails. Use the void* parameter to pass any contextual information the callback may need in order to react properly. Relevant information can be copied from the EOS SDK's cache while the callback function is running. You do not need to remove the callback function.

Callback Function Information

Because this function is asynchronous, it employs a callback of type EOS_Sessions_OnRegisterPlayersCallback to report the results of its operation.

Callback Remarks

Function prototype definition for callbacks passed to EOS_Sessions_RegisterPlayers

Callback Parameters

EOS_Sessions_OnRegisterPlayersCallback

Parameter Type And Name

Usage Information

const EOS_Sessions_RegisterPlayersCallbackInfo* Data

A EOS_Sessions_RegisterPlayersCallbackInfo containing the output information and result

Related API Members

This function is part of the Sessions Interface.

Remarks

Register a group of players with the session, allowing them to invite others or otherwise indicate they are part of the session for determining a full session {Result.NoChange} if the players to register registered previously {Result.InvalidParameters} if any of the options are incorrect {Result.SessionsOutOfSync} if the session is out of sync and will be updated on the next connection with the backend {Result.NotFound} if a session to register players does not exist

Return Value

{Result.Success} if the register completes successfully

Parameters

Sessions.SessionsInterface.RegisterPlayers

Parameter Type And Name

Usage Information

RegisterPlayersOptions options

Structure containing information about the session and players to be registered

object clientData

Arbitrary data that is passed back to you in the CompletionDelegate

OnRegisterPlayersCallback completionDelegate

A callback that is fired when the registration operation completes, either successfully or in error

This function is asynchronous; the EOS SDK guarantees that your callback (the CompletionDelegate parameter) will run when the operation completes, regardless of whether it succeeds or fails. Use the object parameter to pass any contextual information the callback may need in order to react properly. Relevant information can be copied from the EOS SDK's cache while the callback function is running. You do not need to remove the callback function.

Callback Function Information

Because this function is asynchronous, it employs a callback of type Sessions.OnRegisterPlayersCallback to report the results of its operation.

Callback Remarks

Function prototype definition for callbacks passed to {SessionsInterface.RegisterPlayers}

Callback Parameters

Sessions.OnRegisterPlayersCallback

Parameter Type And Name

Usage Information

RegisterPlayersCallbackInfo data

A EOS_Sessions_RegisterPlayersCallbackInfo containing the output information and result

Related API Members