Provided by: libsdl3-doc_3.2.8+ds-1_all bug

NAME

       SDL_swprintf - This works exactly like swprintf() but doesn't require access to a C runtime.

HEADER FILE

       Defined in SDL3/SDL_stdinc.h

SYNOPSIS

       #include "SDL3/SDL.h"

       int SDL_swprintf(wchar_t *text, size_t maxlen, const wchar_t *fmt, ...);

DESCRIPTION

       Format a wide string of up to maxlen -1 wchar_t values, converting each

       While  some  C  runtimes  differ on how to deal with too-large strings, this function null-terminates the
       output, by treating the null-terminator as part of the  maxlen  count.  Note  that  if  maxlen  is  zero,
       however, no wide characters will be written at all.

       This  function  returns  the  number  of  _wide  characters_  (not  _codepoints_) that should be written,
       excluding the null-terminator character. If this returns a number >= maxlen , it means the output  string
       was truncated. A negative return value means an error occurred.

       Referencing the output string's pointer with a format item is undefined behavior.

FUNCTION PARAMETERS

       text   the buffer to write the wide string into. Must not be NULL.

       maxlen the maximum wchar_t values to write, including the null-terminator.

       fmt    a printf-style format string. Must not be NULL.

       ...    a list of values to be used with the format string.

RETURN VALUE

       Returns the number of wide characters that should be written, not counting the null-terminator char, or a
       negative value on error.

THREAD SAFETY

       It is safe to call this function from any thread.

AVAILABILITY

       This function is available since SDL 3.2.0.

Simple Directmedia Layer                            SDL 3.2.8                                    SDL_swprintf(3)