glib/gerror.h

   1 /* gerror.h - Error reporting system
   2  *
   3  *  Copyright 2000 Red Hat, Inc.
   4  *
   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.
   9  *
  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.
  14  *
  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.
  19  */
  20
  21 #ifndef __GERROR_H__
  22 #define __GERROR_H__
  23
  24 #ifdef __cplusplus
  25 extern "C"
  26 {
  27 #endif
  28
  29 typedef struct _GError GError;
  30
  31 struct _GError
  32 {
  33   GQuark       domain;
  34   gint         code;
  35   gchar       *message;
  36 };
  37
  38 GError*  g_error_new           (GQuark         domain,
  39                                 gint           code,
  40                                 const gchar   *format,
  41                                 ...) G_GNUC_PRINTF (3, 4);
  42
  43 GError*  g_error_new_literal   (GQuark         domain,
  44                                 gint           code,
  45                                 const gchar   *message);
  46
  47 void     g_error_free          (GError        *error);
  48 GError*  g_error_copy          (const GError  *error);
  49
  50 gboolean g_error_matches       (const GError  *error,
  51                                 GQuark         domain,
  52                                 gint           code);
  53
  54 /* if (err) *err = g_error_new(domain, code, format, ...), also has
  55  * some sanity checks.
  56  */
  57 void     g_set_error           (GError       **err,
  58                                 GQuark         domain,
  59                                 gint           code,
  60                                 const gchar   *format,
  61                                 ...) G_GNUC_PRINTF (4, 5);
  62
  63 /* if (dest) *dest = src; also has some sanity checks.
  64  */
  65 void     g_propagate_error     (GError       **dest,
  66                                 GError        *src);
  67
  68 /* if (err && *err) { g_error_free(*err); *err = NULL; } */
  69 void     g_clear_error         (GError       **err);
  70
  71
  72 #ifdef __cplusplus
  73 }
  74 #endif
  75
  76 #endif /* __GERROR_H__ */
  77