API reference
API reference
Select your platform
No SDKs available
No versions available

ovr_Challenges_Leave Function

If the current user has the necessary permissions, they can leave a challenge by providing the challenge ID, which can be obtained using ovr_Challenge_GetID(). ovrMessage_Challenges_Leave will be generated in response.
First call ovr_Message_IsError() to check if an error occurred.
If no error occurred, the message will contain a payload of type ovrChallengeHandle. Extract the payload from the message handle with ovr_Message_GetChallenge().

Signature

ovrRequest ovr_Challenges_Leave(ovrID challengeID)

Parameters

challengeID: ovrID The ID of challenge that the user is going to leave. It can be retrieved by ovr_Challenge_GetID().

Returns