SDL_SetError - Man Page
Set the SDL error message for the current thread.
Header File
Defined in SDL3/SDL_error.h
Synopsis
#include "SDL3/SDL.h" bool SDL_SetError(const char *fmt, ...);
Description
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.
See Also
·(3), SDL_ClearError(3), ·(3), SDL_GetError(3), ·(3), SDL_SetErrorV(3)
Referenced By
SDL_ClearError(3), SDL_GetError(3), SDL_SetErrorV(3).
SDL 3.2.2 Simple Directmedia Layer SDL3 FUNCTIONS