(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_InvalidParamError

A macro to standardize error reporting on unsupported operations.

Header File

Defined in <SDL3/SDL_error.h>

Syntax

#define SDL_InvalidParamError(param)    SDL_SetError("Parameter '%s' is invalid", (param))

Remarks

This simply calls SDL_SetError() with a standardized error string, for convenience, consistency, and clarity.

A common usage pattern inside SDL is this:

bool MyFunction(const char *str) {
    if (!str) {
        return SDL_InvalidParamError("str");  // returns false.
    }
    DoSomething(str);
    return true;
}

Thread Safety

It is safe to call this macro from any thread.

Version

This macro is available since SDL 3.1.3.

---

CategoryAPI, CategoryAPIMacro, CategoryError

[ 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.