HklError

typedef struct {
	char *message;
} HklError;

hkl_error_new ()

HklError*           hkl_error_new                       (const char *format,
                                                         ...);

Creates a new HklError with the given, and a message formatted with format.

hkl_error_new_literal ()

HklError*           hkl_error_new_literal               (const char *message);

Creates a new HklError; unlike hkl_error_new(), message is not a printf()-style format string. Use this function if message contains text you don't have control over, that could include printf() escape sequences.

hkl_error_new_valist ()

HklError*           hkl_error_new_valist                (const char *format,
                                                         va_list args);

Creates a new HklError with the given message formatted with format.

Since 2.22

hkl_error_free ()

void                hkl_error_free                      (HklError *error);

Frees a HklError and associated resources.

hkl_error_new_copy ()

HklError*           hkl_error_new_copy                  (const HklError *error);

hkl_error_set ()

void                hkl_error_set                       (HklError **err,
                                                         const char *format,
                                                         ...);

Does nothing if err is NULL; if err is non-NULL, then *err must be NULL. A new HklError is created and assigned to *err.

hkl_error_set_literal ()

void                hkl_error_set_literal               (HklError **err,
                                                         const char *message);

Does nothing if err is NULL; if err is non-NULL, then *err must be NULL. A new HklError is created and assigned to *err. Unlike hkl_set_error(), message is not a printf()-style format string. Use this function if message contains text you don't have control over, that could include printf() escape sequences.

Since 2.18

hkl_error_propagate ()

void                hkl_error_propagate                 (HklError **dest,
                                                         HklError *src);

hkl_error_clear ()

void                hkl_error_clear                     (HklError **err);

hkl_error_prefix ()

void                hkl_error_prefix                    (HklError **err,
                                                         const char *format,
                                                         ...);

hkl_error_propagate_prefixed ()

void                hkl_error_propagate_prefixed        (HklError **dest,
                                                         HklError *src,
                                                         const char *format,
                                                         ...);