SDL_SetError(3)

SDL_SetError3

Set the sdl error message for the current thread.

Usage

#include "SDL3/SDL.h"

bool SDL_SetError(const char *fmt, ...);

Header file

Defined in SDL3/SDL_error.h

Overview

Calling this function will replace any previous error message that was set.

This function always returns false, since SDL frequently uses false to signify a failing result, leading to this idiom:

if (error_code) {
    return SDL_SetError("This operation has failed: %d", error_code);
}

Function parameters

fmt

a printf()-style message format string.

...

additional parameters matching % tokens in the fmt string, if any.

Return value

Returns false.

Thread safety

It is safe to call this function from any thread.

Availability

This function is available since SDL 3.2.0.

From libsdl3-doc 3.2.10+ds-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.