EOS API reference page for EOS_Sessions_UpdateSession

3 분 소요

This function is part of the Sessions Interface.


Update a session given a session modification handle created by EOS_Sessions_CreateSessionModification or EOS_Sessions_UpdateSessionModification

Return Value

  • EOS_Success if the update completes successfully

  • 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 be updated does not exist

  • EOS_LimitExceeded if a new session cannot be created because doing so would exceed the maximum allowed concurrent session count

  • EOS_InvalidUser if the local user associated with the session to update does not exist or is not authenticated



Parameter Type And NameUsage Information
EOS_HSessions Handle
const EOS_Sessions_UpdateSessionOptions* OptionsStructure containing information about the session to be updated
void* ClientDataArbitrary data that is passed back to you in the CompletionDelegate
const EOS_Sessions_OnUpdateSessionCallback CompletionDelegateA callback that is fired when the update operation completes, either successfully or in error

Callback Function Information

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

Callback Remarks

Function prototype definition for callbacks passed to EOS_Sessions_UpdateSession

Callback Parameters


Parameter Type And NameUsage Information
const EOS_Sessions_UpdateSessionCallbackInfo* DataA EOS_Sessions_UpdateSessionCallbackInfo containing the output information and result