include/SDL_error.h
changeset 1895 c121d94672cb
parent 1361 19418e4422cb
child 2859 99210400e8b9
equal deleted inserted replaced
1894:c69cee13dd76 1895:c121d94672cb
    18 
    18 
    19     Sam Lantinga
    19     Sam Lantinga
    20     slouken@libsdl.org
    20     slouken@libsdl.org
    21 */
    21 */
    22 
    22 
    23 /* Simple error message routines for SDL */
    23 /**
       
    24  * \file SDL_error.h
       
    25  * Simple error message routines for SDL
       
    26  */
    24 
    27 
    25 #ifndef _SDL_error_h
    28 #ifndef _SDL_error_h
    26 #define _SDL_error_h
    29 #define _SDL_error_h
    27 
    30 
    28 #include "SDL_stdinc.h"
    31 #include "SDL_stdinc.h"
    29 
    32 
    30 #include "begin_code.h"
    33 #include "begin_code.h"
    31 /* Set up for C function definitions, even when using C++ */
    34 /* Set up for C function definitions, even when using C++ */
    32 #ifdef __cplusplus
    35 #ifdef __cplusplus
       
    36 /* *INDENT-OFF* */
    33 extern "C" {
    37 extern "C" {
       
    38 /* *INDENT-ON* */
    34 #endif
    39 #endif
    35 
    40 
    36 /* Public functions */
    41 /* Public functions */
    37 extern DECLSPEC void SDLCALL SDL_SetError(const char *fmt, ...);
    42 extern DECLSPEC void SDLCALL SDL_SetError(const char *fmt, ...);
    38 extern DECLSPEC char * SDLCALL SDL_GetError(void);
    43 extern DECLSPEC char *SDLCALL SDL_GetError(void);
    39 extern DECLSPEC void SDLCALL SDL_ClearError(void);
    44 extern DECLSPEC void SDLCALL SDL_ClearError(void);
    40 
    45 
    41 /* Private error message function - used internally */
    46 /* Private error message function - used internally */
    42 #define SDL_OutOfMemory()	SDL_Error(SDL_ENOMEM)
    47 #define SDL_OutOfMemory()	SDL_Error(SDL_ENOMEM)
    43 #define SDL_Unsupported()	SDL_Error(SDL_UNSUPPORTED)
    48 #define SDL_Unsupported()	SDL_Error(SDL_UNSUPPORTED)
    44 typedef enum {
    49 typedef enum
    45 	SDL_ENOMEM,
    50 {
    46 	SDL_EFREAD,
    51     SDL_ENOMEM,
    47 	SDL_EFWRITE,
    52     SDL_EFREAD,
    48 	SDL_EFSEEK,
    53     SDL_EFWRITE,
    49 	SDL_UNSUPPORTED,
    54     SDL_EFSEEK,
    50 	SDL_LASTERROR
    55     SDL_UNSUPPORTED,
       
    56     SDL_LASTERROR
    51 } SDL_errorcode;
    57 } SDL_errorcode;
    52 extern DECLSPEC void SDLCALL SDL_Error(SDL_errorcode code);
    58 extern DECLSPEC void SDLCALL SDL_Error(SDL_errorcode code);
    53 
    59 
    54 
    60 
    55 /* Ends C function definitions when using C++ */
    61 /* Ends C function definitions when using C++ */
    56 #ifdef __cplusplus
    62 #ifdef __cplusplus
       
    63 /* *INDENT-OFF* */
    57 }
    64 }
       
    65 /* *INDENT-ON* */
    58 #endif
    66 #endif
    59 #include "close_code.h"
    67 #include "close_code.h"
    60 
    68 
    61 #endif /* _SDL_error_h */
    69 #endif /* _SDL_error_h */
       
    70 
       
    71 /* vi: set ts=4 sw=4 expandtab: */