My Project
Functions
SDL_error.h File Reference
#include "SDL_stdinc.h"
#include "begin_code.h"
#include "close_code.h"

Go to the source code of this file.

Functions

DECLSPEC int SDLCALL SDL_SetError (SDL_PRINTF_FORMAT_STRING const char *fmt,...) SDL_PRINTF_VARARG_FUNC(1)
 Set the error message for the current thread. More...
 
DECLSPEC const char *SDLCALL SDL_GetError (void)
 Get the last error message that was set. More...
 
DECLSPEC char *SDLCALL SDL_GetErrorMsg (char *errstr, int maxlen)
 Get the last error message that was set for the current thread. More...
 
DECLSPEC void SDLCALL SDL_ClearError (void)
 Clear the error message for the current thread.
 

Internal error functions

#define SDL_OutOfMemory()   SDL_Error(SDL_ENOMEM)
 
#define SDL_Unsupported()   SDL_Error(SDL_UNSUPPORTED)
 
#define SDL_InvalidParamError(param)   SDL_SetError("Parameter '%s' is invalid", (param))
 
enum  SDL_errorcode {
  SDL_ENOMEM, SDL_EFREAD, SDL_EFWRITE, SDL_EFSEEK,
  SDL_UNSUPPORTED, SDL_LASTERROR
}
 
DECLSPEC int SDLCALL SDL_Error (SDL_errorcode code)
 

Detailed Description

Simple error message routines for SDL.

Function Documentation

◆ SDL_GetError()

DECLSPEC const char* SDLCALL SDL_GetError ( void  )

Get the last error message that was set.

SDL API functions may set error messages and then succeed, so you should only use the error value if a function fails.

This returns a pointer to a static buffer for convenience and should not be called by multiple threads simultaneously.

Returns
a pointer to the last error message that was set

◆ SDL_GetErrorMsg()

DECLSPEC char* SDLCALL SDL_GetErrorMsg ( char *  errstr,
int  maxlen 
)

Get the last error message that was set for the current thread.

SDL API functions may set error messages and then succeed, so you should only use the error value if a function fails.

Parameters
errstrA buffer to fill with the last error message that was set for the current thread
maxlenThe size of the buffer pointed to by the errstr parameter
Returns
errstr

◆ SDL_SetError()

DECLSPEC int SDLCALL SDL_SetError ( SDL_PRINTF_FORMAT_STRING const char *  fmt,
  ... 
)

Set the error message for the current thread.

Returns
-1, there is no error handling for this function