ibuserror

ibuserror — Error message output.

Stability Level

Stable, unless otherwise indicated

Synopsis

typedef             IBusError;
IBusError *         ibus_error_new                      (void);
IBusError *         ibus_error_new_from_text            (const gchar *name,
                                                         const gchar *message);
IBusError *         ibus_error_new_from_printf          (const gchar *name,
                                                         const gchar *format_message,
                                                         ...);
IBusError *         ibus_error_new_from_message         (DBusMessage *message);
void                ibus_error_free                     (IBusError *error);

Description

An IBusError is actually a DBusError. Functions listed here are convenient wrapper for IBusError new and free.

Details

IBusError

typedef DBusError IBusError;

A data type representing an IBusError. An IBusError is actually a DBusError.

see_also: DBusError for detail structure definition.


ibus_error_new ()

IBusError *         ibus_error_new                      (void);

New an empty IBusError.

Returns :

A newly allocated IBusError.

ibus_error_new_from_text ()

IBusError *         ibus_error_new_from_text            (const gchar *name,
                                                         const gchar *message);

New an IBusError from error name and message.

name :

The error name.

message :

Detailed error message.

Returns :

A newly allocated IBusError.

ibus_error_new_from_printf ()

IBusError *         ibus_error_new_from_printf          (const gchar *name,
                                                         const gchar *format_message,
                                                         ...);

New an IBusError from error name and a printf-formatted message.

name :

The error name.

format_message :

printf() formatted error message.

... :

Formatting parameters.

Returns :

A newly allocated IBusError.

ibus_error_new_from_message ()

IBusError *         ibus_error_new_from_message         (DBusMessage *message);

New an IBusError from a DBusMessage.

message :

A DBusMessage

Returns :

A newly allocated IBusError.

ibus_error_free ()

void                ibus_error_free                     (IBusError *error);

Free an IBusError.

error :

An IBusError