EOS_Sessions_GetInviteIdByIndex

EOS API reference page for EOS_Sessions_GetInviteIdByIndex

Choose your implementation method:

C

C#

This function is part of the Sessions Interface.

Remarks

Retrieve an invite ID from a list of active invites for a given user

Return Value

  • EOS_Success if the input is valid and an invite ID was returned

  • EOS_InvalidParameters if any of the options are incorrect

  • EOS_NotFound if the invite doesn't exist

See Also

EOS_Sessions_GetInviteCount, EOS_Sessions_CopySessionHandleByInviteId

Parameters

EOS_Sessions_GetInviteIdByIndex

Parameter Type And Name

Usage Information

EOS_HSessions Handle

const EOS_Sessions_GetInviteIdByIndexOptions* Options

Structure containing the input parameters

char* OutBuffer

int32_t* InOutBufferLength

Related API Members

This function is part of the Sessions Interface.

Remarks

Retrieve an invite ID from a list of active invites for a given user {Result.InvalidParameters} if any of the options are incorrect {Result.NotFound} if the invite doesn't exist

Return Value

{Result.Success} if the input is valid and an invite ID was returned

See Also

{GetInviteCount}, {CopySessionHandleByInviteId}

Parameters

Sessions.SessionsInterface.GetInviteIdByIndex

Parameter Type And Name

Usage Information

GetInviteIdByIndexOptions options

Structure containing the input parameters

string outBuffer

Related API Members