EOS_Friends_GetFriendAtIndex

EOS API reference page for EOS_Friends_GetFriendAtIndex

Choose your implementation method:

C

C#

This function is part of the [Friends Interface](Interfaces/Friends).

Remarks

Retrieves the Epic Online Services Account ID of an entry from the friends list that has already been retrieved by the EOS_Friends_QueryFriends API. The Epic Online Services Account ID returned by this function may belong to an account that has been invited to be a friend or that has invited the local user to be a friend. To determine if the Epic Online Services Account ID returned by this function is a friend or a pending friend invitation, use the EOS_Friends_GetStatus function.

Return Value

the Epic Online Services Account ID of the friend. Note that if the index provided is out of bounds, the returned Epic Online Services Account ID will be a "null" account ID.

See Also

EOS_Friends_GetFriendsCount, EOS_Friends_GetStatus

Parameters

EOS_Friends_GetFriendAtIndex

Parameter Type And Name

Usage Information

EOS_HFriends Handle

const EOS_Friends_GetFriendAtIndexOptions* Options

structure containing the Epic Online Services Account ID of the owner of the friends list and the index into the list

Related API Members

This function is part of the [Friends Interface](Interfaces/Friends).

Remarks

Retrieves the Epic Online Services Account ID of an entry from the friends list that has already been retrieved by the EOS_Friends_QueryFriends API. The Epic Online Services Account ID returned by this function may belong to an account that has been invited to be a friend or that has invited the local user to be a friend. To determine if the Epic Online Services Account ID returned by this function is a friend or a pending friend invitation, use the EOS_Friends_GetStatus function.

Return Value

the Epic Online Services Account ID of the friend. Note that if the index provided is out of bounds, the returned Epic Online Services Account ID will be a "null" account ID.

See Also

EOS_Friends_GetFriendsCount, EOS_Friends_GetStatus

Parameters

Friends.FriendsInterface.GetFriendAtIndex

Parameter Type And Name

Usage Information

GetFriendAtIndexOptions options

structure containing the Epic Online Services Account ID of the owner of the friends list and the index into the list

Related API Members

Tags