EOS_AntiCheatClient_PollStatus

EOS API reference page for EOS_AntiCheatClient_PollStatus

Choose your implementation method:

C

C#

This function is part of the AntiCheatClient Interface.

Remarks

Polls for changes in client integrity status. Mode: All The purpose of this function is to allow the game to display information about anti-cheat integrity problems to the user. These are often the result of a corrupt game installation rather than cheating attempts. This function does not check for violations, it only provides information about violations which have automatically been discovered by the anti-cheat client. Such a violation may occur at any time and afterwards the user will be unable to join any protected multiplayer session until after restarting the game.

Return Value

  • EOS_Success - If violation information was returned successfully

  • EOS_LimitExceeded - If OutMessage is too small to receive the message string. Call again with a larger OutMessage.

  • EOS_NotFound - If no violation has occurred since the last call

Parameters

EOS_AntiCheatClient_PollStatus

Parameter Type And Name

Usage Information

EOS_HAntiCheatClient Handle

const EOS_AntiCheatClient_PollStatusOptions* Options

Structure containing input data.

EOS_EAntiCheatClientViolationType* ViolationType

On success, receives a code describing the violation that occurred.

char* OutMessage

On success, receives a string describing the violation which should be displayed to the user.

Related API Members

This function is part of the AntiCheatClient Interface.

Remarks

Polls for changes in client integrity status. Mode: All The purpose of this function is to allow the game to display information about anti-cheat integrity problems to the user. These are often the result of a corrupt game installation rather than cheating attempts. This function does not check for violations, it only provides information about violations which have automatically been discovered by the anti-cheat client. Such a violation may occur at any time and afterwards the user will be unable to join any protected multiplayer session until after restarting the game. {Result.LimitExceeded} - If OutMessage is too small to receive the message string. Call again with a larger OutMessage. {Result.NotFound} - If no violation has occurred since the last call

Return Value

{Result.Success} - If violation information was returned successfully

Parameters

AntiCheatClient.AntiCheatClientInterface.PollStatus

Parameter Type And Name

Usage Information

PollStatusOptions options

Structure containing input data.

AntiCheatClientViolationType violationType

On success, receives a code describing the violation that occurred.

string outMessage

On success, receives a string describing the violation which should be displayed to the user.

Related API Members

Tags