(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_iconv

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

Header File

Syntax

size_t SDL_iconv(SDL_iconv_t cd, const char **inbuf,
             size_t *inbytesleft, char **outbuf,
             size_t *outbytesleft);


#define SDL_ICONV_ERROR     (size_t)-1  /**< Generic error. Check SDL_GetError()? */
#define SDL_ICONV_E2BIG     (size_t)-2  /**< Output buffer was too small. */
#define SDL_ICONV_EILSEQ    (size_t)-3  /**< Invalid input sequence was encountered. */
#define SDL_ICONV_EINVAL    (size_t)-4  /**< Incomplete input sequence was encountered. */

Function Parameters

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

Return Value

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

Remarks

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.

Version

This function is available since SDL 3.1.3.