My Project
Loading...
Searching...
No Matches
SDL_error.h
Go to the documentation of this file.
1/*
2 Simple DirectMedia Layer
3 Copyright (C) 1997-2023 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
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
36extern "C" {
37#endif
38
39/* Public functions */
40
41
66extern DECLSPEC int SDLCALL SDL_SetError(SDL_PRINTF_FORMAT_STRING const char *fmt, ...) SDL_PRINTF_VARARG_FUNC(1);
67
103extern DECLSPEC const char *SDLCALL SDL_GetError(void);
104
120extern DECLSPEC char * SDLCALL SDL_GetErrorMsg(char *errstr, int maxlen);
121
130extern DECLSPEC void SDLCALL SDL_ClearError(void);
131
138/* @{ */
139#define SDL_OutOfMemory() SDL_Error(SDL_ENOMEM)
140#define SDL_Unsupported() SDL_Error(SDL_UNSUPPORTED)
141#define SDL_InvalidParamError(param) SDL_SetError("Parameter '%s' is invalid", (param))
142typedef enum
143{
144 SDL_ENOMEM,
145 SDL_EFREAD,
146 SDL_EFWRITE,
147 SDL_EFSEEK,
148 SDL_UNSUPPORTED,
149 SDL_LASTERROR
150} SDL_errorcode;
151/* SDL_Error() unconditionally returns -1. */
152extern DECLSPEC int SDLCALL SDL_Error(SDL_errorcode code);
153/* @} *//* Internal error functions */
154
155/* Ends C function definitions when using C++ */
156#ifdef __cplusplus
157}
158#endif
159#include "close_code.h"
160
161#endif /* SDL_error_h_ */
162
163/* vi: set ts=4 sw=4 expandtab: */
DECLSPEC void SDLCALL SDL_ClearError(void)
DECLSPEC char *SDLCALL SDL_GetErrorMsg(char *errstr, int maxlen)
DECLSPEC int SDLCALL SDL_SetError(SDL_PRINTF_FORMAT_STRING const char *fmt,...) SDL_PRINTF_VARARG_FUNC(1)
DECLSPEC const char *SDLCALL SDL_GetError(void)