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)
DECLSPEC const char *SDLCALL	SDL_GetError (void)
DECLSPEC void SDLCALL	SDL_ClearError (void)

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.

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 54 of file SDL_error.h.

SDL_OutOfMemory

#define SDL_OutOfMemory

(

)

SDL_Error(SDL_ENOMEM)

Definition at line 52 of file SDL_error.h.

SDL_Unsupported

#define SDL_Unsupported

(

)

SDL_Error(SDL_UNSUPPORTED)

Definition at line 53 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 55 of file SDL_error.h.

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

Function Documentation

SDL_ClearError()

DECLSPEC void SDLCALL SDL_ClearError

(

void

)

SDL_Error()

DECLSPEC int SDLCALL SDL_Error

(

SDL_errorcode

code

)

SDL_GetError()

DECLSPEC const char* SDLCALL SDL_GetError

(

void

)

SDL_SetError()

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