g_dbus_error_is_remote_error ()

gboolean
g_dbus_error_is_remote_error (const GError *error);

Checks if error represents an error received via D-Bus from a remote peer. If so, use g_dbus_error_get_remote_error() to get the name of the error.

Since: 2.26

g_dbus_error_get_remote_error ()

gchar *
g_dbus_error_get_remote_error (const GError *error);

Gets the D-Bus error name used for error , if any.

This function is guaranteed to return a D-Bus error name for all GErrors returned from functions handling remote method calls (e.g. g_dbus_connection_call_finish()) unless g_dbus_error_strip_remote_error() has been used on error .

Since: 2.26

g_dbus_error_strip_remote_error ()

gboolean
g_dbus_error_strip_remote_error (GError *error);

Looks for extra information in the error message used to recover the D-Bus error name and strips it if found. If stripped, the message field in error will correspond exactly to what was received on the wire.

This is typically used when presenting errors to the end user.

Since: 2.26

g_dbus_error_register_error_domain ()

void
g_dbus_error_register_error_domain (const gchar *error_domain_quark_name,
                                    volatile gsize *quark_volatile,
                                    const GDBusErrorEntry *entries,
                                    guint num_entries);

Helper function for associating a GError error domain with D-Bus error names.

Since: 2.26

g_dbus_error_register_error ()

gboolean
g_dbus_error_register_error (GQuark error_domain,
                             gint error_code,
                             const gchar *dbus_error_name);

Creates an association to map between dbus_error_name and GErrors specified by error_domain and error_code .

This is typically done in the routine that returns the GQuark for an error domain.

Since: 2.26

g_dbus_error_unregister_error ()

gboolean
g_dbus_error_unregister_error (GQuark error_domain,
                               gint error_code,
                               const gchar *dbus_error_name);

Destroys an association previously set up with g_dbus_error_register_error().

Since: 2.26

g_dbus_error_new_for_dbus_error ()

GError *
g_dbus_error_new_for_dbus_error (const gchar *dbus_error_name,
                                 const gchar *dbus_error_message);

Creates a GError based on the contents of dbus_error_name and dbus_error_message .

Errors registered with g_dbus_error_register_error() will be looked up using dbus_error_name and if a match is found, the error domain and code is used. Applications can use g_dbus_error_get_remote_error() to recover dbus_error_name .

If a match against a registered error is not found and the D-Bus error name is in a form as returned by g_dbus_error_encode_gerror() the error domain and code encoded in the name is used to create the GError. Also, dbus_error_name is added to the error message such that it can be recovered with g_dbus_error_get_remote_error().

Otherwise, a GError with the error code G_IO_ERROR_DBUS_ERROR in the G_IO_ERROR error domain is returned. Also, dbus_error_name is added to the error message such that it can be recovered with g_dbus_error_get_remote_error().

In all three cases, dbus_error_name can always be recovered from the returned GError using the g_dbus_error_get_remote_error() function (unless g_dbus_error_strip_remote_error() hasn't been used on the returned error).

This function is typically only used in object mappings to prepare GError instances for applications. Regular applications should not use it.

Since: 2.26

g_dbus_error_set_dbus_error ()

void
g_dbus_error_set_dbus_error (GError **error,
                             const gchar *dbus_error_name,
                             const gchar *dbus_error_message,
                             const gchar *format,
                             ...);

Does nothing if error is NULL. Otherwise sets *error to a new GError created with g_dbus_error_new_for_dbus_error() with dbus_error_message prepend with format (unless NULL).

Since: 2.26

g_dbus_error_set_dbus_error_valist ()

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);

Like g_dbus_error_set_dbus_error() but intended for language bindings.

Since: 2.26

g_dbus_error_encode_gerror ()

gchar *
g_dbus_error_encode_gerror (const GError *error);

Creates a D-Bus error name to use for error . If error matches a registered error (cf. g_dbus_error_register_error()), the corresponding D-Bus error name will be returned.

Otherwise the a name of the form org.gtk.GDBus.UnmappedGError.Quark._ESCAPED_QUARK_NAME.Code_ERROR_CODE will be used. This allows other GDBus applications to map the error on the wire back to a GError using g_dbus_error_new_for_dbus_error().

This function is typically only used in object mappings to put a GError on the wire. Regular applications should not use it.

Since: 2.26

enum GDBusError

Error codes for the G_DBUS_ERROR error domain.

Since: 2.26

G_DBUS_ERROR

#define G_DBUS_ERROR g_dbus_error_quark()

Error domain for errors generated by a remote message bus. Errors in this domain will be from the GDBusError enumeration. See GError for more information on error domains.

Note that this error domain is intended only for returning errors from a remote message bus process. Errors generated locally in-process by e.g. GDBusConnection should use the G_IO_ERROR domain.

Since: 2.26

GDBusErrorEntry

typedef struct {
  gint         error_code;
  const gchar *dbus_error_name;
} GDBusErrorEntry;

Struct used in g_dbus_error_register_error_domain().

Since: 2.26