Functions | |
void | dbus_error_init (DBusError *error) |
Initializes a DBusError structure. | |
void | dbus_error_free (DBusError *error) |
Frees an error that's been set (or just initialized), then reinitializes the error as in dbus_error_init(). | |
void | dbus_set_error_const (DBusError *error, const char *name, const char *message) |
Assigns an error name and message to a DBusError. | |
void | dbus_move_error (DBusError *src, DBusError *dest) |
Moves an error src into dest, freeing src and overwriting dest. | |
dbus_bool_t | dbus_error_has_name (const DBusError *error, const char *name) |
Checks whether the error is set and has the given name. | |
dbus_bool_t | dbus_error_is_set (const DBusError *error) |
Checks whether an error occurred (the error is set). | |
void | dbus_set_error (DBusError *error, const char *name, const char *format,...) |
Assigns an error name and message to a DBusError. |
Types and functions related to reporting errors.
In essence D-BUS error reporting works as follows:
DBusError error; dbus_error_init (&error); dbus_some_function (arg1, arg2, &error); if (dbus_error_is_set (&error)) { fprintf (stderr, "an error occurred: %s\n", error.message); dbus_error_free (&error); }
There are some rules. An error passed to a D-BUS function must always be unset; you can't pass in an error that's already set. If a function has a return code indicating whether an error occurred, and also a DBusError parameter, then the error will always be set if and only if the return code indicates an error occurred. i.e. the return code and the error are never going to disagree.
An error only needs to be freed if it's been set, not if it's merely been initialized.
You can check the specific error that occurred using dbus_error_has_name().
|
Frees an error that's been set (or just initialized), then reinitializes the error as in dbus_error_init().
Definition at line 174 of file dbus-errors.c. References DBusRealError::const_message, dbus_error_init(), dbus_free(), DBusRealError::message, and NULL. Referenced by _dbus_keyring_new_homedir(), _dbus_transport_open(), dbus_g_bus_get(), dbus_g_proxy_end_call(), dbus_g_proxy_new_for_service_owner(), and dbus_move_error(). |
|
Checks whether the error is set and has the given name.
Definition at line 260 of file dbus-errors.c. References _dbus_assert, _dbus_string_equal(), _dbus_string_init_const(), FALSE, DBusError::message, DBusError::name, and NULL. |
|
Initializes a DBusError structure. Does not allocate any memory; the error only needs to be freed if it is set at some point.
Definition at line 151 of file dbus-errors.c. References _dbus_assert, DBusRealError::const_message, DBusRealError::message, DBusRealError::name, NULL, and TRUE. Referenced by _dbus_keyring_new_homedir(), _dbus_transport_open(), dbus_error_free(), dbus_g_bus_get(), dbus_g_proxy_end_call(), dbus_g_proxy_new_for_service_owner(), and dbus_move_error(). |
|
Checks whether an error occurred (the error is set).
Definition at line 287 of file dbus-errors.c. References _dbus_assert, FALSE, DBusError::message, DBusError::name, and NULL. Referenced by dbus_g_proxy_new_for_service_owner(), and dbus_set_g_error(). |
|
Moves an error src into dest, freeing src and overwriting dest. Both src and dest must be initialized. src is reinitialized to an empty error. dest may not contain an existing error. If the destination is NULL, just frees and reinits the source error.
Definition at line 237 of file dbus-errors.c. References dbus_error_free(), and dbus_error_init(). Referenced by _dbus_transport_open(). |
|
|
Assigns an error name and message to a DBusError. Does nothing if error is NULL. The message may be NULL, which means a default message will be deduced from the name. If the error name is unknown to D-BUS the default message will be totally useless, though.
Definition at line 201 of file dbus-errors.c. References _dbus_assert, DBusRealError::const_message, DBusError::message, DBusRealError::message, DBusError::name, DBusRealError::name, NULL, and TRUE. Referenced by _dbus_keyring_get_best_key(), and _dbus_keyring_new_homedir(). |