---
name: "SDL_SetError"
section: "3"
platform: "linux"
package: "libsdl3-doc"
version: "3.2.10+ds-1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/SDL_SetError"
---

# SDL\_SetError(3)

Set the SDL error message for the current thread.

## NAME

SDL\_SetError - 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)](/SDL_ClearError/3.md), **•**(3), [**SDL\_GetError**(3)](/SDL_GetError/3.md), **•**(3), [**SDL\_SetErrorV**(3)](/SDL_SetErrorV/3.md)
