SDL_SetError

Set the SDL error message for the current thread.

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

extern (C) nothrow @nogc extern
bool
SDL_SetError
(
const(char)* fmt
,)

Parameters

fmt const(char)*

a printf()-style message format string. ... = additional parameters matching % tokens in the fmt string, if any.

Return Value

Type: bool

false

Threadsafety: It is safe to call this function from any thread.

Examples

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);
}

See Also

Meta