include/SDL_error.h
author Sam Lantinga <slouken@libsdl.org>
Mon, 17 Jan 2011 09:09:15 -0800
changeset 5009 b21ad135d86b
parent 4867 ba7492f9e2b8
child 5221 2ee8112bfc6b
permissions -rw-r--r--
Minor documentation consistency cleanup
     1 /*
     2     SDL - Simple DirectMedia Layer
     3     Copyright (C) 1997-2010 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 /**
    24  *  \file SDL_error.h
    25  *  
    26  *  Simple error message routines for SDL.
    27  */
    28 
    29 #ifndef _SDL_error_h
    30 #define _SDL_error_h
    31 
    32 #include "SDL_stdinc.h"
    33 
    34 #include "begin_code.h"
    35 /* Set up for C function definitions, even when using C++ */
    36 #ifdef __cplusplus
    37 /* *INDENT-OFF* */
    38 extern "C" {
    39 /* *INDENT-ON* */
    40 #endif
    41 
    42 /* Public functions */
    43 extern DECLSPEC void 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 message function - used internally.
    52  */
    53 /*@{*/
    54 #define SDL_OutOfMemory()	SDL_Error(SDL_ENOMEM)
    55 #define SDL_Unsupported()	SDL_Error(SDL_UNSUPPORTED)
    56 typedef enum
    57 {
    58     SDL_ENOMEM,
    59     SDL_EFREAD,
    60     SDL_EFWRITE,
    61     SDL_EFSEEK,
    62     SDL_UNSUPPORTED,
    63     SDL_LASTERROR
    64 } SDL_errorcode;
    65 extern DECLSPEC void SDLCALL SDL_Error(SDL_errorcode code);
    66 /*@}*//*Internal error functions*/
    67 
    68 /* Ends C function definitions when using C++ */
    69 #ifdef __cplusplus
    70 /* *INDENT-OFF* */
    71 }
    72 /* *INDENT-ON* */
    73 #endif
    74 #include "close_code.h"
    75 
    76 #endif /* _SDL_error_h */
    77 
    78 /* vi: set ts=4 sw=4 expandtab: */