EOS API reference page for EOS_UI_ShowFriends

3 mins to read

This function is part of the UI Interface.


Opens the Social Overlay with a request to show the friends list.

Return Value

  • EOS_Success If the Social Overlay has been notified about the request.

  • EOS_IncompatibleVersion if the API version passed in is incorrect.

  • EOS_InvalidParameters If any of the options are incorrect.

  • EOS_NotConfigured If the Social Overlay is not properly configured.

  • EOS_NoChange If the Social Overlay is already visible.

  • EOS_ApplicationSuspended If the application is suspended.

  • EOS_NetworkDisconnected If the network is disconnected.



Parameter Type And NameUsage Information
EOS_HUI Handle
const EOS_UI_ShowFriendsOptions* OptionsStructure containing the Epic Account ID of the friends list to show.
void* ClientDataArbitrary data that is passed back to you in the CompletionDelegate.
const EOS_UI_OnShowFriendsCallback CompletionDelegateA callback that is fired when the request to show the friends list has been sent to the Social Overlay, or on an error.

Callback Function Information

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

Callback Remarks

Function prototype definition for callbacks passed to EOS_UI_ShowFriends

Callback Parameters


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