EOS API reference page for EOS_Sanctions_QueryActivePlayerSanctions

This function is part of the [Sanctions Interface](Interfaces/Sanctions).


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 Name

Usage Information

EOS_HSanctions Handle

const EOS_Sanctions_QueryActivePlayerSanctionsOptions* Options

Structure containing the input parameters

void* ClientData

Arbitrary data that is passed back to you in the CompletionDelegate

const EOS_Sanctions_OnQueryActivePlayerSanctionsCallback CompletionDelegate

A callback that is fired when the async operation completes, either successfully or in error

This function is asynchronous; the EOS SDK guarantees that your callback (the CompletionDelegate parameter) will run when the operation completes, regardless of whether it succeeds or fails. Use the void* parameter to pass any contextual information the callback may need in order to react properly. Relevant information can be copied from the EOS SDK's cache while the callback function is running. You do not need to remove the callback function.

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 Name

Usage Information

const EOS_Sanctions_QueryActivePlayerSanctionsCallbackInfo* Data

A EOS_Sanctions_QueryActivePlayerSanctionsCallbackInfo containing the output information and result

Related API Members