summaryrefslogtreecommitdiff
path: root/gdbus/gdbuserror.h
blob: 3c426f0400bca41cc1eff2b4e499f8ff0bedf00a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
/* GDBus - GLib D-Bus Library
 *
 * Copyright (C) 2008-2009 Red Hat, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General
 * Public License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
 * Boston, MA 02111-1307, USA.
 *
 * Author: David Zeuthen <davidz@redhat.com>
 */

#if !defined (__G_DBUS_G_DBUS_H_INSIDE__) && !defined (G_DBUS_COMPILATION)
#error "Only <gdbus/gdbus.h> can be included directly."
#endif

#ifndef __G_DBUS_ERROR_H__
#define __G_DBUS_ERROR_H__

#include <gdbus/gdbustypes.h>

G_BEGIN_DECLS

/**
 * G_DBUS_ERROR:
 *
 * Error domain for GDBus. Errors in this domain will be from the #GDBusError enumeration.
 * See #GError for more information on error domains.
 **/
#define G_DBUS_ERROR g_dbus_error_quark()

GQuark g_dbus_error_quark (void);

/* Used by applications to check, get and strip the D-Bus error name */
gboolean g_dbus_error_is_remote_error       (const GError *error);
gchar   *g_dbus_error_get_remote_error      (const GError *error);
gboolean g_dbus_error_strip_remote_error    (GError       *error);

/* Used by applications to associate GError domains with D-Bus error names */
gboolean g_dbus_error_register_error        (GQuark        error_domain,
                                             gint          error_code,
                                             const gchar  *dbus_error_name);
gboolean g_dbus_error_unregister_error      (GQuark        error_domain,
                                             gint          error_code,
                                             const gchar  *dbus_error_name);

/* Only used by object mappings to map back and forth to GError */
GError  *g_dbus_error_new_for_dbus_error    (const gchar  *dbus_error_name,
                                             const gchar  *dbus_error_message);
void     g_dbus_error_set_dbus_error        (GError      **error,
                                             const gchar  *dbus_error_name,
                                             const gchar  *dbus_error_message,
                                             const gchar  *format,
                                             ...);
void     g_dbus_error_set_dbus_error_valist (GError      **error,
                                             const gchar  *dbus_error_name,
                                             const gchar  *dbus_error_message,
                                             const gchar  *format,
                                             va_list       var_args);
gchar   *g_dbus_error_encode_gerror         (const GError *error);

G_END_DECLS

#endif /* __G_DBUS_ERROR_H__ */