include/SDL_error.h

   1 /*
   2     SDL - Simple DirectMedia Layer
   3     Copyright (C) 1997-2006 Sam Lantinga
   4
   5     This library is free software; you can redistribute it and/or
   6     modify it under the terms of the GNU Lesser General Public
   7     License as published by the Free Software Foundation; either
   8     version 2.1 of the License, or (at your option) any later version.
   9
  10     This library is distributed in the hope that it will be useful,
  11     but WITHOUT ANY WARRANTY; without even the implied warranty of
  12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13     Lesser General Public License for more details.
  14
  15     You should have received a copy of the GNU Lesser General Public
  16     License along with this library; if not, write to the Free Software
  17     Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  18
  19     Sam Lantinga
  20     slouken@libsdl.org
  21 */
  22
  23 /* Simple error message routines for SDL */
  24
  25 #ifndef _SDL_error_h
  26 #define _SDL_error_h
  27
  28 #include "SDL_stdinc.h"
  29
  30 #include "begin_code.h"
  31 /* Set up for C function definitions, even when using C++ */
  32 #ifdef __cplusplus
  33 extern "C" {
  34 #endif
  35
  36 /* Public functions */
  37 extern DECLSPEC void SDLCALL SDL_SetError(const char *fmt, ...);
  38 extern DECLSPEC char * SDLCALL SDL_GetError(void);
  39 extern DECLSPEC void SDLCALL SDL_ClearError(void);
  40
  41 /* Private error message function - used internally */
  42 #define SDL_OutOfMemory()       SDL_Error(SDL_ENOMEM)
  43 #define SDL_Unsupported()       SDL_Error(SDL_UNSUPPORTED)
  44 typedef enum {
  45         SDL_ENOMEM,
  46         SDL_EFREAD,
  47         SDL_EFWRITE,
  48         SDL_EFSEEK,
  49         SDL_UNSUPPORTED,
  50         SDL_LASTERROR
  51 } SDL_errorcode;
  52 extern DECLSPEC void SDLCALL SDL_Error(SDL_errorcode code);
  53
  54
  55 /* Ends C function definitions when using C++ */
  56 #ifdef __cplusplus
  57 }
  58 #endif
  59 #include "close_code.h"
  60
  61 #endif /* _SDL_error_h */