EOS_SessionModification_SetBucketId

EOS API reference page for EOS_SessionModification_SetBucketId

Choose your implementation method:

C

C#

This function is part of the Sessions Interface.

Remarks

Set the bucket ID associated with this session. Values such as region, game mode, etc can be combined here depending on game need. Setting this is strongly recommended to improve search performance.

Return Value

  • EOS_Success if setting this parameter was successful

  • EOS_InvalidParameters if the bucket ID is invalid or null

  • EOS_IncompatibleVersion if the API version passed in is incorrect

Parameters

EOS_SessionModification_SetBucketId

Parameter Type And Name

Usage Information

EOS_HSessionModification Handle

const EOS_SessionModification_SetBucketIdOptions* Options

Options associated with the bucket ID of the session

Related API Members

This function is part of the Sessions Interface.

Remarks

Set the bucket ID associated with this session. Values such as region, game mode, etc can be combined here depending on game need. Setting this is strongly recommended to improve search performance. {Result.InvalidParameters} if the bucket ID is invalid or null {Result.IncompatibleVersion} if the API version passed in is incorrect

Return Value

{Result.Success} if setting this parameter was successful

Parameters

Sessions.SessionModification.SetBucketId

Parameter Type And Name

Usage Information

SessionModificationSetBucketIdOptions options

Options associated with the bucket ID of the session

Related API Members