include/SDL_error.h
author Sam Lantinga <slouken@libsdl.org>
Sat, 18 May 2013 12:48:50 -0700
changeset 7190 11612d544fcd
parent 7037 3fedf1f25b94
child 7191 75360622e65f
permissions -rw-r--r--
Added mobile application events, with implementations for iOS and Android
     1 /*
     2   Simple DirectMedia Layer
     3   Copyright (C) 1997-2013 Sam Lantinga <slouken@libsdl.org>
     4 
     5   This software is provided 'as-is', without any express or implied
     6   warranty.  In no event will the authors be held liable for any damages
     7   arising from the use of this software.
     8 
     9   Permission is granted to anyone to use this software for any purpose,
    10   including commercial applications, and to alter it and redistribute it
    11   freely, subject to the following restrictions:
    12 
    13   1. The origin of this software must not be misrepresented; you must not
    14      claim that you wrote the original software. If you use this software
    15      in a product, an acknowledgment in the product documentation would be
    16      appreciated but is not required.
    17   2. Altered source versions must be plainly marked as such, and must not be
    18      misrepresented as being the original software.
    19   3. This notice may not be removed or altered from any source distribution.
    20 */
    21 
    22 /**
    23  *  \file SDL_error.h
    24  *  
    25  *  Simple error message routines for SDL.
    26  */
    27 
    28 #ifndef _SDL_error_h
    29 #define _SDL_error_h
    30 
    31 #include "SDL_stdinc.h"
    32 
    33 #include "begin_code.h"
    34 /* Set up for C function definitions, even when using C++ */
    35 #ifdef __cplusplus
    36 /* *INDENT-OFF* */
    37 extern "C" {
    38 /* *INDENT-ON* */
    39 #endif
    40 
    41 /* Public functions */
    42 /* SDL_SetError() unconditionally returns -1. */
    43 extern DECLSPEC int SDLCALL SDL_SetError(const char *fmt, ...);
    44 extern DECLSPEC const char *SDLCALL SDL_GetError(void);
    45 extern DECLSPEC void SDLCALL SDL_ClearError(void);
    46 
    47 /**
    48  *  \name Internal error functions
    49  *  
    50  *  \internal 
    51  *  Private error reporting function - used internally.
    52  */
    53 /*@{*/
    54 #define SDL_OutOfMemory()	SDL_Error(SDL_ENOMEM)
    55 #define SDL_Unsupported()	SDL_Error(SDL_UNSUPPORTED)
    56 #define SDL_InvalidParamError(param)	SDL_SetError("Parameter '%s' is invalid", (param))
    57 typedef enum
    58 {
    59     SDL_ENOMEM,
    60     SDL_EFREAD,
    61     SDL_EFWRITE,
    62     SDL_EFSEEK,
    63     SDL_UNSUPPORTED,
    64     SDL_LASTERROR
    65 } SDL_errorcode;
    66 /* SDL_Error() unconditionally returns -1. */
    67 extern DECLSPEC int SDLCALL SDL_Error(SDL_errorcode code);
    68 /*@}*//*Internal error functions*/
    69 
    70 /* Ends C function definitions when using C++ */
    71 #ifdef __cplusplus
    72 /* *INDENT-OFF* */
    73 }
    74 /* *INDENT-ON* */
    75 #endif
    76 #include "close_code.h"
    77 
    78 #endif /* _SDL_error_h */
    79 
    80 /* vi: set ts=4 sw=4 expandtab: */