sdlSwprintf function

int sdlSwprintf(
  1. Pointer<NativeType> arg0,
  2. int maxlen,
  3. Pointer<Int16> fmt,
  4. Pointer<NativeType> arg3,
)

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

Format a wide string of up to maxlen-1 wchar_t values, converting each '%' item with values provided through variable arguments.

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.

\param text the buffer to write the wide string into. Must not be NULL. \param maxlen the maximum wchar_t values to write, including the null-terminator. \param fmt a printf-style format string. Must not be NULL. \param ... a list of values to be used with the format string. \returns the number of wide characters that should be written, not counting the null-terminator char, or a negative value on error.

\threadsafety It is safe to call this function from any thread.

\since This function is available since SDL 3.1.3.

extern SDL_DECLSPEC int SDLCALL SDL_swprintf(SDL_OUT_Z_CAP(maxlen) wchar_t *text, size_t maxlen, SDL_PRINTF_FORMAT_STRING const wchar_t *fmt, ...) SDL_WPRINTF_VARARG_FUNC(3)

Implementation

int sdlSwprintf(Pointer<NativeType> arg0, int maxlen, Pointer<Int16> fmt,
    Pointer<NativeType> arg3) {
  final sdlSwprintfLookupFunction = libSdl3.lookupFunction<
      Int32 Function(Pointer<NativeType> arg0, Uint32 maxlen,
          Pointer<Int16> fmt, Pointer<NativeType> arg3),
      int Function(Pointer<NativeType> arg0, int maxlen, Pointer<Int16> fmt,
          Pointer<NativeType> arg3)>('SDL_swprintf');
  return sdlSwprintfLookupFunction(arg0, maxlen, fmt, arg3);
}