SDL_iconv_string - Man Page

Helper function to convert a string's encoding in one call.

Header File

Defined in SDL3/SDL_stdinc.h

Synopsis

#include "SDL3/SDL.h"

char * SDL_iconv_string(const char *tocode,
                   const char *fromcode,
                   const char *inbuf,
                   size_t inbytesleft);

Description

This function converts a buffer or string between encodings in one pass.

The string does not need to be NULL-terminated; this function operates on the number of bytes specified in inbytesleft whether there is a NULL character anywhere in the buffer.

The returned string is owned by the caller, and should be passed to

SDL_free
when no longer needed.

Function Parameters

tocode

the character encoding of the output string. Examples are "UTF-8", "UCS-4", etc.

fromcode

the character encoding of data in inbuf .

inbuf

the string to convert to a different encoding.

inbytesleft

the size of the input string _in bytes_.

Return Value

Returns a new string, converted to the new encoding, or NULL on error.

Availability

This function is available since SDL 3.2.0.

See Also

·(3), SDL_iconv_open(3), ·(3), SDL_iconv_close(3), ·(3), SDL_iconv(3)

Referenced By

SDL_iconv(3), SDL_iconv_close(3), SDL_iconv_open(3).

SDL 3.2.8 Simple Directmedia Layer SDL3 FUNCTIONS