EOS API reference page for EOS_UI_ShowReportPlayer

3 분 소요

This function is part of the UI Interface.


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

Return Value

  • EOS_Success If the 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_ApplicationSuspended If the application is suspended.

  • EOS_NetworkDisconnected If the network is disconnected.



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

Callback Function Information

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

Callback Remarks

Function prototype definition for callbacks passed to EOS_UI_ShowReportPlayer

Callback Parameters


Parameter Type And NameUsage Information
const EOS_UI_OnShowReportPlayerCallbackInfo* DataA EOS_UI_OnShowReportPlayerCallbackInfo 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_ShowReportPlayer
EOS_EpicAccountId LocalUserIdThe Epic Online Services Account ID of the user who requested the Report.
EOS_EpicAccountId TargetUserIdThe Epic Online Services Account ID of the user who was to be Reported.

For more information, see the EOS_UI_OnShowReportPlayerCallbackInfo page.