rc_client_get_user_agent_clause

Gets a subclause indicating the rcheevos version for inclusion in a User-Agent string.

For example: rcheevos/11.1 might be returned and could be injected into a User-Agent string like MyEmu/1.2 (rcheevos/11.1).

Syntax

size_t rc_client_get_user_agent_clause(
    rc_client_t* client,
    char buffer[],
    size_t buffersize,
);

Parameters

client

The rc_client_t instance.

buffer

A buffer to populate with the User-Agent clause.

buffer_size

The number of characters that the buffer can hold.

Return value

The length of the generated User-Agent clause. This value may exceed buffer_size, but only buffer_size-1 characters (plus a null terminator) will be written to buffer.

Remarks

Minimum version: 11.1.0

See also

rc_client_create