EOS API reference page for EOS_UI_HideFriends

3 mins to read

This function is part of the UI Interface.


Hides the active Social Overlay.

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 hidden.



Parameter Type And NameUsage Information
EOS_HUI Handle
const EOS_UI_HideFriendsOptions* OptionsStructure containing the Epic Account ID of the browser to close.
void* ClientDataArbitrary data that is passed back to you in the CompletionDelegate.
const EOS_UI_OnHideFriendsCallback CompletionDelegateA callback that is fired when the request to hide the friends list has been processed, or on an error.

Callback Function Information

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

Callback Remarks

Function prototype definition for callbacks passed to EOS_UI_HideFriends

Callback Parameters


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