Man page - sdl_iconv(3)

Packages contains this manual

Package: libsdl3-doc
apt-get install libsdl3-doc

Documentations in package:

Manual

SDL_iconv

NAME
HEADER FILE
SYNOPSIS
DESCRIPTION
FUNCTION PARAMETERS
RETURN VALUE
AVAILABILITY
SEE ALSO

NAME

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

HEADER FILE

Defined in SDL3/SDL_stdinc.h

SYNOPSIS

#include "SDL3/SDL.h"

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. */

DESCRIPTION

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.

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