1 /* GDBus - GLib D-Bus Library
3 * Copyright (C) 2008-2010 Red Hat, Inc.
5 * SPDX-License-Identifier: LGPL-2.1-or-later
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General
18 * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
20 * Author: David Zeuthen <davidz@redhat.com>
23 #ifndef __G_DBUS_ERROR_H__
24 #define __G_DBUS_ERROR_H__
26 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
27 #error "Only <gio/gio.h> can be included directly."
30 #include <gio/giotypes.h>
31 #include <gio/tizen_header_glib.h> /* for TIZEN_PUBLIC_DEPRECATED_API */
38 * Error domain for errors generated by a remote message bus. Errors
39 * in this domain will be from the #GDBusError enumeration. See
40 * #GError for more information on error domains.
42 * Note that this error domain is intended only for
43 * returning errors from a remote message bus process. Errors
44 * generated locally in-process by e.g. #GDBusConnection should use the
49 #define G_DBUS_ERROR g_dbus_error_quark()
52 GQuark g_dbus_error_quark (void) TIZEN_PUBLIC_DEPRECATED_API;
54 /* Used by applications to check, get and strip the D-Bus error name */
56 gboolean g_dbus_error_is_remote_error (const GError *error) TIZEN_PUBLIC_DEPRECATED_API;
58 gchar *g_dbus_error_get_remote_error (const GError *error) TIZEN_PUBLIC_DEPRECATED_API;
60 gboolean g_dbus_error_strip_remote_error (GError *error) TIZEN_PUBLIC_DEPRECATED_API;
64 * @error_code: An error code.
65 * @dbus_error_name: The D-Bus error name to associate with @error_code.
67 * Struct used in g_dbus_error_register_error_domain().
71 struct _GDBusErrorEntry
74 const gchar *dbus_error_name;
78 gboolean g_dbus_error_register_error (GQuark error_domain,
80 const gchar *dbus_error_name) TIZEN_PUBLIC_DEPRECATED_API;
82 gboolean g_dbus_error_unregister_error (GQuark error_domain,
84 const gchar *dbus_error_name) TIZEN_PUBLIC_DEPRECATED_API;
86 void g_dbus_error_register_error_domain (const gchar *error_domain_quark_name,
87 volatile gsize *quark_volatile,
88 const GDBusErrorEntry *entries,
89 guint num_entries) TIZEN_PUBLIC_DEPRECATED_API;
91 /* Only used by object mappings to map back and forth to GError */
93 GError *g_dbus_error_new_for_dbus_error (const gchar *dbus_error_name,
94 const gchar *dbus_error_message) TIZEN_PUBLIC_DEPRECATED_API;
96 void g_dbus_error_set_dbus_error (GError **error,
97 const gchar *dbus_error_name,
98 const gchar *dbus_error_message,
100 ...) G_GNUC_PRINTF(4, 5) TIZEN_PUBLIC_DEPRECATED_API;
102 void g_dbus_error_set_dbus_error_valist (GError **error,
103 const gchar *dbus_error_name,
104 const gchar *dbus_error_message,
106 va_list var_args) G_GNUC_PRINTF(4, 0) TIZEN_PUBLIC_DEPRECATED_API;
108 gchar *g_dbus_error_encode_gerror (const GError *error) TIZEN_PUBLIC_DEPRECATED_API;
112 #endif /* __G_DBUS_ERROR_H__ */