This is new wiki software and old wiki content. It's a work in progress!
Here's the explanation.
Be gentle, report bugs, leave feedback on pages, or just edit them yourself! Thanks!

SDL Wiki

SDL_SetError

Set the SDL error message for the current thread.

Syntax

int SDL_SetError(SDL_PRINTF_FORMAT_STRING const char *fmt, ...) SDL_PRINTF_VARARG_FUNC(1);

Function Parameters

fmt

a printf()-style message format string

...

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

Return Value

Returns always -1.

Remarks

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

This function always returns -1, since SDL frequently uses -1 to signify an failing result, leading to this idiom:

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

Code Examples

SDL_SetError("Something unexpected happened!");
int errorCode = 0;
...
errorCode = -37;
...
if (errorCode < 0)
    SDL_SetError("Something unexpected happened: Error Code %d", errorCode);
SDL_ClearError
SDL_GetError

CategoryAPI, CategoryError


[ edit | delete | history | feedback | raw ]

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.