rc_api_init_fetch_image_request

Constructs an rc_api_request_t for requesting an image.

Syntax

int rc_api_init_fetch_image_request(
    rc_api_request_t* request,
    const rc_api_fetch_image_request_t* api_params
);

// 12.0+ (alternate)
int rc_api_init_fetch_image_request_hosted(
    rc_api_request_t* request,
    const rc_api_fetch_image_request_t* api_params,
    const rc_api_host_t* host
);

Parameters

request

The rc_api_request_t to construct.

api_params

Pointer to a rc_api_fetch_image_request_t object containing the parameters for the new leaderboard entry.

host (Minimum version: 12.0.0)

Pointer to a rc_api_host_t object containing custom host information.

---

struct rc_api_fetch_image_request_t
{
  const char* image_name;
  int image_type;
};

image_name

The name of the image being requested. Depends on the image_type parameter.

• RC_IMAGE_TYPE_GAME - the image_name field of the rc_api_fetch_game_data_response_t.
• RC_IMAGE_TYPE_ACHIEVEMENT - the badge_name field of the rc_api_achievement_definition_t.
• RC_IMAGE_TYPE_ACHIEVEMENT_LOCKED - the badge_name field of the rc_api_achievement_definition_t.
• RC_IMAGE_TYPE_USER - the username field of the rc_api_login_response_t.

image_type

The type of image being requested.

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_STATE - one or more required parameters was not provided.
• RC_OUT_OF_MEMORY - enough memory could not be allocated to complete the operation.

Remarks

The response from the server is the raw image file. There are no response processing functions to call for this API.

The rc_api_request_t must be destroyed by rc_api_destroy_request after the HTTP request has been made.

Minimum version: 10.0.0

See also

rc_api_destroy_request