(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous 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

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

---

CategoryAPI, CategoryAPIFunction, CategoryHIDAPI

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.