rc_api_process_award_achievement_response

Parses the response for awarding an achievement to a user.

Syntax

// 11.0+
int rc_api_process_award_achievement_server_response(
    rc_api_award_achievement_response_t* response,
    const rc_api_server_response_t* server_response
);

// [deprecated]
int rc_api_process_award_achievement_response(
    rc_api_award_achievement_response_t* response,
    const char* server_response
);

Parameters

response

The rc_api_award_achievement_response_t to construct.

server_response

The body of the HTTP response received from the server.

---

struct rc_api_award_achievement_response_t
{
  unsigned awarded_achievement_id;
  unsigned new_player_score;
  unsigned achievements_remaining;
  rc_api_response_t response;
};

awarded_achievement_id

The unique identifier of the achievement that was awarded.

new_player_score

The new value of the player's RetroAchievements score.

achievements_remaining (Minimum version: 10.3.0)

The number of achievements the user has yet to unlock before completing (non-hardcore) or mastering (hardcore) the game.

response

Common server-provided response information. Contains a succeeded flag, and an error_message field.

Return value

If the function succeeds, the return value is RC_OK. Otherwise, the error code can be converted to a string using rc_error_str.

• RC_INVALID_JSON - the response was not valid JSON.
• RC_MISSING_VALUE - one or more required fields was not found in the response.

Remarks

The rc_api_award_achievement_response_t must be destroyed by rc_api_destroy_award_achievement_response when the caller is done with it.

Minimum version: 10.0.0

See also

rc_api_init_award_achievement_request

rc_api_destroy_award_achievement_response