SDL_hid_get_indexed_string(3)

💖 SDL_hid_get_indexed_string 💖

okay bestie, welcome to the SDL3 FUNCTIONS corner of the manual, and today's main character is SDL_hid_get_indexed_string — yes she's a mouthful, yes she ate. ✨

🌸 NAME 🌸

SDL_hid_get_indexed_string — get a string from a HID device, based on its string index. that's it, that's the whole vibe. 🎀

---

🦋 SYNOPSIS 🦋

#include <SDL3/SDL_hidapi.h>

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

look at her signature. so clean. so intentional. 💅

---

🍓 FUNCTION PARAMETERS 🍓

• dev — a device handle returned from SDL_hid_open(). yes, you gotta have opened the device first, no shortcuts, we don't do that here. 🙈
• string_index — the index of the string you want to get. literally the number that points at which string, iykyk.
• string — a wide string buffer to put the data into. wide. as in wchar_t wide. bring your own buffer, bestie, she's not allocating one for you. 🫶
• maxlen — the length of the buffer, counted in multiples of wchar_t. so it's not bytes, it's how many wchar_ts fit. important. do not get this wrong. 😭

---

👑 RETURN VALUE 👑

Returns 0 on success, or a negative error code on failure. and if it fails you must call SDL_GetError() for more information — she's not gonna spill the tea on her own, you gotta ask. 💀

---

🌈 AVAILABILITY 🌈

This function is available since SDL 3.2.0. so if you're on something older, that's a vibe check you're failing, bestie. ⭐

---

and that's the whole page!! go forth and get those indexed HID strings, you absolute icon. 🧚💜

— with love from the Simple Directmedia Layer girlies, SDL 3.4.18, SDL_hid_get_indexed_string(3). periodt. 💖✨