1 /* gerror.h - Error reporting system
3 * Copyright 2000 Red Hat, Inc.
5 * The Gnome Library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public License as
7 * published by the Free Software Foundation; either version 2 of the
8 * License, or (at your option) any later version.
10 * The Gnome 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.
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with the Gnome Library; see the file COPYING.LIB. If not,
17 * write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 * Boston, MA 02111-1307, USA.
24 #if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
25 #error "Only <glib.h> can be included directly."
30 #include <glib/gquark.h>
36 * @domain: error domain, e.g. #G_FILE_ERROR
37 * @code: error code, e.g. %G_FILE_ERROR_NOENT
38 * @message: human-readable informative error message
40 * The <structname>GError</structname> structure contains
41 * information about an error that has occurred.
43 typedef struct _GError GError
;
53 GError
* g_error_new (GQuark domain
,
56 ...) G_GNUC_PRINTF (3, 4);
59 GError
* g_error_new_literal (GQuark domain
,
61 const gchar
*message
);
63 GError
* g_error_new_valist (GQuark domain
,
66 va_list args
) G_GNUC_PRINTF(3, 0);
69 void g_error_free (GError
*error
);
71 GError
* g_error_copy (const GError
*error
);
74 gboolean
g_error_matches (const GError
*error
,
78 /* if (err) *err = g_error_new(domain, code, format, ...), also has
82 void g_set_error (GError
**err
,
86 ...) G_GNUC_PRINTF (4, 5);
89 void g_set_error_literal (GError
**err
,
92 const gchar
*message
);
94 /* if (dest) *dest = src; also has some sanity checks.
97 void g_propagate_error (GError
**dest
,
100 /* if (err && *err) { g_error_free(*err); *err = NULL; } */
101 GLIB_AVAILABLE_IN_ALL
102 void g_clear_error (GError
**err
);
104 /* if (err) prefix the formatted string to the ->message */
105 GLIB_AVAILABLE_IN_ALL
106 void g_prefix_error (GError
**err
,
108 ...) G_GNUC_PRINTF (2, 3);
110 /* g_propagate_error then g_error_prefix on dest */
111 GLIB_AVAILABLE_IN_ALL
112 void g_propagate_prefixed_error (GError
**dest
,
115 ...) G_GNUC_PRINTF (3, 4);
119 #endif /* __G_ERROR_H__ */