SDL_hid_get_indexed_string

Get a string from a HID device, based on its string index.

Header File

Defined in <SDL3/SDL_hidapi.h>

Syntax

int SDL_hid_get_indexed_string(SDL_hid_device *dev, int string_index, wchar_t *string, size_t maxlen);

Function Parameters

SDL_hid_device * dev a device handle returned from SDL_hid_open().
int string_index the index of the string to get.
wchar_t * string a wide string buffer to put the data into.
size_t maxlen the length of the buffer in multiples of wchar_t.

Return Value

(int) Returns 0 on success or a negative error code on failure; call SDL_GetError() for more information.

Version

This function is available since SDL 3.2.0.

CategoryAPI, CategoryAPIFunction, CategoryHIDAPI