devela::_dep::sdl3::sys::hidapi

Function SDL_hid_get_indexed_string

pub unsafe extern "C" fn SDL_hid_get_indexed_string(
    dev: *mut SDL_hid_device,
    string_index: i32,
    string: *mut u32,
    maxlen: usize,
) -> i32
Available on crate feature dep_sdl3 only.
Expand description

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

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

§Availability

This function is available since SDL 3.2.0.