devela::_dep::sdl3::sys::stdinc

Function SDL_iconv

pub unsafe extern "C" fn SDL_iconv(
    cd: *mut SDL_iconv_data_t,
    inbuf: *mut *const i8,
    inbytesleft: *mut usize,
    outbuf: *mut *mut i8,
    outbytesleft: *mut usize,
) -> usize
Available on crate feature dep_sdl3 only.
Expand description

This function converts text between encodings, reading from and writing to a buffer.

It returns the number of succesful conversions on success. On error, SDL_ICONV_E2BIG is returned when the output buffer is too small, or SDL_ICONV_EILSEQ is returned when an invalid input sequence is encountered, or SDL_ICONV_EINVAL is returned when an incomplete input sequence is encountered.

On exit:

  • inbuf will point to the beginning of the next multibyte sequence. On error, this is the location of the problematic input sequence. On success, this is the end of the input sequence.
  • inbytesleft will be set to the number of bytes left to convert, which will be 0 on success.
  • outbuf will point to the location where to store the next output byte.
  • outbytesleft will be set to the number of bytes left in the output buffer.

§Parameters

  • cd: The character set conversion context, created in SDL_iconv_open().
  • inbuf: Address of variable that points to the first character of the input sequence.
  • inbytesleft: The number of bytes in the input buffer.
  • outbuf: Address of variable that points to the output buffer.
  • outbytesleft: The number of bytes in the output buffer.

§Return value

Returns the number of conversions on success, or a negative error code.

§Availability

This function is available since SDL 3.2.0.

§See also