Skip to content

rc_api_process_fetch_game_titles_server_response

Jamiras edited this page Jun 17, 2024 · 1 revision

Parses the response for fetching the titles and badges associated to a list of games.

Syntax

int rc_api_process_fetch_game_titles_server_response(
    rc_api_fetch_game_titles_response_t* response,
    const rc_api_server_response_t* server_response
);

Parameters

response

The rc_api_fetch_game_titles_response_t to construct.

server_response

The body of the HTTP response received from the server.


struct rc_api_fetch_game_titles_response_t
{
  rc_api_game_title_entry_t* entries;
  unsigned num_entries;

  rc_api_response_t response;
};

entries

An array of rc_api_game_title_entry_t game list entries.

num_entries

The number of items in the entries array.

response

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


struct rc_api_game_title_entry_t
{
  unsigned id;
  const char* title;
  const char* image_name;
};

id

The unique identifier of the game.

name

The title of the game.

image_name

The image name for the game badge.

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_fetch_game_titles_response_t must be destroyed by rc_api_destroy_fetch_game_titles_response when the caller is done with it.

Minimum version: 11.4.0

See also

rc_api_init_fetch_game_titles_request

rc_api_destroy_fetch_game_titles_response

rcheevos

rc_client

Integration guide

client

user

game

processing

rc_client_raintegration

Integration guide

rc_runtime

rhash

rapi

common

user

runtime

info

Clone this wiki locally