EOS API reference page for EOS_UI_ShowBlockPlayer

3 mins to read

This function is part of the UI Interface.


Requests that the Social Overlay open and display the "Block User" flow for the specified user.



Parameter Type And NameUsage Information
EOS_HUI Handle
const EOS_UI_ShowBlockPlayerOptions* Options
void* ClientDataArbitrary data that is passed back to you in the NotificationFn.
const EOS_UI_OnShowBlockPlayerCallback CompletionDelegate

Callback Function Information

Because this function is asynchronous, it employs a callback of type EOS_UI_OnShowBlockPlayerCallback to report the results of its operation. See the EOS_UI_OnShowBlockPlayerCallbackInfo page for more details, or check the [Callback Data] section below.

Callback Remarks

Function prototype definition for callbacks passed to EOS_UI_ShowBlockPlayer

Callback Parameters


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

Callback Data

The EOS SDK passes the following data structure to the callback function:


EOS_EResult ResultCodeThe EOS_EResult code for the operation. EOS_Success indicates that the operation succeeded; other codes indicate errors.
void* ClientDataContext that was passed into EOS_UI_ShowBlockPlayer
EOS_EpicAccountId LocalUserIdThe Epic Online Services Account ID of the user who requested the block.
EOS_EpicAccountId TargetUserIdThe Epic Online Services Account ID of the user who was to be blocked.

For more information, see the EOS_UI_OnShowBlockPlayerCallbackInfo page.