EOS API reference page for EOS_Sanctions_QueryActivePlayerSanctions

2 분 소요

This function is part of the Sanctions Interface.


Start an asynchronous query to retrieve any active sanctions for a specified user. Call EOS_Sanctions_GetPlayerSanctionCount and EOS_Sanctions_CopyPlayerSanctionByIndex to retrieve the data.

See Also

EOS_Sanctions_GetPlayerSanctionCount, EOS_Sanctions_CopyPlayerSanctionByIndex



Parameter Type And NameUsage Information
EOS_HSanctions Handle
const EOS_Sanctions_QueryActivePlayerSanctionsOptions* OptionsStructure containing the input parameters
void* ClientDataArbitrary data that is passed back to you in the CompletionDelegate
const EOS_Sanctions_OnQueryActivePlayerSanctionsCallback CompletionDelegateA callback that is fired when the async operation completes, either successfully or in error

Callback Function Information

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

Callback Remarks

Function prototype definition for callbacks passed to EOS_Sanctions_QueryActivePlayerSanctions

Callback Parameters


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