Skip to main content

SDL_SetError

Function SDL_SetError 

Source
pub unsafe extern "C" fn SDL_SetError(fmt: *const c_char, ...) -> bool
Expand description

Set the SDL error message for the current thread.

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

Parameter: fmt a printf()-style message format string. Parameter: … additional parameters matching % tokens in the fmt string, if any. Returns: false.

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

Available Since: This function is available since SDL 3.2.0.

See Also: SDL_ClearError See Also: SDL_GetError See Also: SDL_SetErrorV