1/* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
2/* dbus-errors.h Error reporting
3 *
4 * Copyright (C) 2002 Red Hat Inc.
5 * Copyright (C) 2003 CodeFactory AB
6 *
7 * Licensed under the Academic Free License version 2.1
8 *
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22 *
23 */
24#if !defined (DBUS_INSIDE_DBUS_H) && !defined (DBUS_COMPILATION)
25#error "Only <dbus/dbus.h> can be included directly, this file may disappear or change contents."
26#endif
27
28#ifndef DBUS_ERROR_H
29#define DBUS_ERROR_H
30
31#include <dbus/dbus-macros.h>
32#include <dbus/dbus-types.h>
33#include <dbus/dbus-protocol.h>
34
35DBUS_BEGIN_DECLS
36
37/**
38 * @addtogroup DBusErrors
39 * @{
40 */
41
42/** Mostly-opaque type representing an error that occurred */
43typedef struct DBusError DBusError;
44
45/**
46 * Object representing an exception.
47 */
48struct DBusError
49{
50 const char *name; /**< public error name field */
51 const char *message; /**< public error message field */
52
53 unsigned int dummy1 : 1; /**< placeholder */
54 unsigned int dummy2 : 1; /**< placeholder */
55 unsigned int dummy3 : 1; /**< placeholder */
56 unsigned int dummy4 : 1; /**< placeholder */
57 unsigned int dummy5 : 1; /**< placeholder */
58
59 void *padding1; /**< placeholder */
60};
61
62#define DBUS_ERROR_INIT { NULL, NULL, TRUE, 0, 0, 0, 0, NULL }
63
64DBUS_EXPORT
65void dbus_error_init (DBusError *error);
66DBUS_EXPORT
67void dbus_error_free (DBusError *error);
68DBUS_EXPORT
69void dbus_set_error (DBusError *error,
70 const char *name,
71 const char *message,
72 ...) _DBUS_GNUC_PRINTF (3, 4);
73DBUS_EXPORT
74void dbus_set_error_const (DBusError *error,
75 const char *name,
76 const char *message);
77DBUS_EXPORT
78void dbus_move_error (DBusError *src,
79 DBusError *dest);
80DBUS_EXPORT
81dbus_bool_t dbus_error_has_name (const DBusError *error,
82 const char *name);
83DBUS_EXPORT
84dbus_bool_t dbus_error_is_set (const DBusError *error);
85
86/** @} */
87
88DBUS_END_DECLS
89
90#endif /* DBUS_ERROR_H */
91