SDL_error.h File Reference

#include "SDL_stdinc.h"
#include "begin_code.h"
#include "close_code.h"

Include dependency graph for SDL_error.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

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

Internal error functions
Private error reporting function - used internally.
#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 }
int	SDL_Error (SDL_errorcode code)

Detailed Description

Simple error message routines for SDL.

Definition in file SDL_error.h.

Macro Definition Documentation

SDL_InvalidParamError

#define SDL_InvalidParamError

(

param

)

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

Definition at line 90 of file SDL_error.h.

SDL_OutOfMemory

#define SDL_OutOfMemory

(

)

SDL_Error(SDL_ENOMEM)

Definition at line 88 of file SDL_error.h.

SDL_Unsupported

#define SDL_Unsupported

(

)

SDL_Error(SDL_UNSUPPORTED)

Definition at line 89 of file SDL_error.h.

Enumeration Type Documentation

SDL_errorcode

enum SDL_errorcode

Enumerator
SDL_ENOMEM
SDL_EFREAD
SDL_EFWRITE
SDL_EFSEEK
SDL_UNSUPPORTED
SDL_LASTERROR

Definition at line 91 of file SDL_error.h.

{
    SDL_ENOMEM,
    SDL_EFREAD,
    SDL_EFWRITE,
    SDL_EFSEEK,
    SDL_UNSUPPORTED,
    SDL_LASTERROR
} SDL_errorcode;

Function Documentation

SDL_ClearError()

void SDL_ClearError

(

void

)

Clear the error message for the current thread.

Definition at line 145 of file SDL_dynapi_procs.h.

References SDL_error::error, and SDL_GetErrBuf().

SDL_Error()

int SDL_Error

(

SDL_errorcode

code

)

Definition at line 69 of file SDL_error.c.

{
    switch (code) {
    case SDL_ENOMEM:
        return SDL_SetError("Out of memory");
    case SDL_EFREAD:
        return SDL_SetError("Error reading from datastream");
    case SDL_EFWRITE:
        return SDL_SetError("Error writing to datastream");
    case SDL_EFSEEK:
        return SDL_SetError("Error seeking in datastream");
    case SDL_UNSUPPORTED:
        return SDL_SetError("That operation is not supported");
    default:
        return SDL_SetError("Unknown SDL error");
    }
}

References SDL_EFREAD, SDL_EFSEEK, SDL_EFWRITE, SDL_ENOMEM, SDL_SetError(), and SDL_UNSUPPORTED.

SDL_GetError()

const char* 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

Definition at line 55 of file SDL_error.c.

{
    const SDL_error *error = SDL_GetErrBuf();
    return error->error ? error->str : "";
}

References SDL_error::error, SDL_GetErrBuf(), and SDL_error::str.

SDL_GetErrorMsg()

char* 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

errstr	A buffer to fill with the last error message that was set for the current thread
maxlen	The size of the buffer pointed to by the errstr parameter

Returns

errstr

Definition at line 106 of file SDL_error.c.

{
    const SDL_error *error = SDL_GetErrBuf();
 
    if (error->error) {
        SDL_strlcpy(errstr, error->str, maxlen);
    } else {
        *errstr = '\0';
    }
 
    return errstr;
}

References SDL_error::error, SDL_GetErrBuf(), SDL_strlcpy, and SDL_error::str.

SDL_SetError()

int 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

Definition at line 31 of file SDL_error.c.

{
    /* Ignore call if invalid format pointer was passed */
    if (fmt != NULL) {
        va_list ap;
        SDL_error *error = SDL_GetErrBuf();
 
        error->error = 1;  /* mark error as valid */
 
        va_start(ap, fmt);
        SDL_vsnprintf(error->str, ERR_MAX_STRLEN, fmt, ap);
        va_end(ap);
 
        if (SDL_LogGetPriority(SDL_LOG_CATEGORY_ERROR) <= SDL_LOG_PRIORITY_DEBUG) {
            /* If we are in debug mode, print out the error message */
            SDL_LogDebug(SDL_LOG_CATEGORY_ERROR, "%s", error->str);
        }
    }
 
    return -1;
}

References ERR_MAX_STRLEN, SDL_error::error, NULL, SDL_GetErrBuf(), SDL_LOG_CATEGORY_ERROR, SDL_LOG_PRIORITY_DEBUG, SDL_LogDebug, SDL_LogGetPriority, SDL_vsnprintf, and SDL_error::str.

Referenced by SDL_Error().