This function is part of the UI Interface.
Remarks
Requests that the Social Overlay open and display the "Block User" flow for the specified user.
Parameters
EOS_UI_ShowBlockPlayer
| Parameter Type And Name | Usage Information |
|---|---|
| EOS_HUI Handle | |
| const EOS_UI_ShowBlockPlayerOptions* Options | |
| void* ClientData | Arbitrary 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
EOS_UI_OnShowBlockPlayerCallback
| Parameter Type And Name | Usage Information |
|---|---|
| const EOS_UI_OnShowBlockPlayerCallbackInfo* Data | A EOS_UI_OnShowBlockPlayerCallbackInfo containing the output information and result |
Callback Data
The EOS SDK passes the following data structure to the callback function:
EOS_UI_OnShowBlockPlayerCallbackInfo
| Property | Value |
|---|---|
| EOS_EResult ResultCode | The EOS_EResult code for the operation. EOS_Success indicates that the operation succeeded; other codes indicate errors. |
| void* ClientData | Context that was passed into EOS_UI_ShowBlockPlayer |
| EOS_EpicAccountId LocalUserId | The Epic Online Services Account ID of the user who requested the block. |
| EOS_EpicAccountId TargetUserId | The Epic Online Services Account ID of the user who was to be blocked. |
For more information, see the EOS_UI_OnShowBlockPlayerCallbackInfo page.