(This is the documentation for SDL3, which is under heavy development and the API is changing! SDL2 is the current stable version!)

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

dev A device handle returned from SDL_hid_open().
string_index The index of the string to get.
string A wide string buffer to put the data into.
maxlen The length of the buffer in multiples of wchar_t.

Return Value

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.0.0.

CategoryAPI, CategoryAPIFunction, CategoryHIDAPI