This group discusses the functions that provide error management for projects. More...
Typedefs | |
typedef int | Eina_Error |
The integer type containing the error type. | |
Functions | |
EAPI Eina_Error | eina_error_msg_register (const char *msg) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT |
Registers a new error type. More... | |
EAPI Eina_Error | eina_error_msg_static_register (const char *msg) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT |
Registers a new error type, statically allocated message. More... | |
EAPI Eina_Bool | eina_error_msg_modify (Eina_Error error, const char *msg) EINA_ARG_NONNULL(2) |
Changes the message of an already registered message. More... | |
EAPI Eina_Error | eina_error_get (void) |
Returns the last set error. More... | |
EAPI void | eina_error_set (Eina_Error err) |
Sets the last error. More... | |
EAPI const char * | eina_error_msg_get (Eina_Error error) EINA_PURE |
Returns the description of the given error number. More... | |
EAPI Eina_Error | eina_error_find (const char *msg) EINA_ARG_NONNULL(1) EINA_PURE |
Finds the Eina_Error corresponding to a message string. More... | |
Variables | |
EAPI Eina_Error | EINA_ERROR_OUT_OF_MEMORY |
The error identifier corresponding to lack of memory. | |
This group discusses the functions that provide error management for projects.
The Eina error module provides a way to manage errors in a simple but powerful way in libraries and modules. It is also used in Eina itself. Similar to libC's errno
and strerror() facilities, this is extensible and recommended for other libraries and applications as well.
A simple example of how to use this can be seen here.
EAPI Eina_Error eina_error_msg_register | ( | const char * | msg | ) |
Registers a new error type.
[in] | msg | The description of the error It is duplicated using eina_stringshare_add(). |
This function stores the error message described by msg
in a list. The returned value is a unique identifier greater than or equal to 1
. The description can be retrieved later by passing the returned value to eina_error_msg_get().
EAPI Eina_Error eina_error_msg_static_register | ( | const char * | msg | ) |
Registers a new error type, statically allocated message.
[in] | msg | The description of the error This string is not duplicated and thus the given pointer should live during the usage of eina_error. |
This function stores the error message described by msg
in a list. The returned value is a unique identifier greater than or equal to 1
. The description can be retrieved later by passing the returned value to eina_error_msg_get().
Referenced by elm_photocam_bounce_get(), and efl::eina::unknown_error().
EAPI Eina_Bool eina_error_msg_modify | ( | Eina_Error | error, |
const char * | msg | ||
) |
Changes the message of an already registered message.
[in] | error | The Eina_Error to change the message of |
[in] | msg | The description of the error This string is duplicated only if the error is registered with eina_error_msg_register, otherwise it must remain intact for the duration. |
This function modifies the message associated with error
and changes it to msg
. If the error is previously registered by eina_error_msg_static_register then the string is not duplicated, otherwise the previous message is unrefed and msg
is copied.
EAPI Eina_Error eina_error_get | ( | void | ) |
Returns the last set error.
This function returns the last error set by eina_error_set(). The description of the message is returned by eina_error_msg_get().
References eina_main_loop_is(), and eina_tls_get().
Referenced by efl::eina::get_error_code(), efl::eina::get_error_code_enum(), and efl::eina::get_error_condition().
EAPI void eina_error_set | ( | Eina_Error | err | ) |
Sets the last error.
[in] | err | The error identifier |
This function sets the last error identifier. The last error can be retrieved by eina_error_get().
err
should be 0
.References eina_main_loop_is(), and eina_tls_set().
Referenced by _eina_safety_error(), edje_edit_state_image_border_fill_set(), edje_edit_state_image_border_set(), edje_edit_state_image_set(), eo_dbg_info_free(), efl::eina::get_error_code(), efl::eina::get_error_condition(), and efl::eina::set_error_code().
EAPI const char* eina_error_msg_get | ( | Eina_Error | error | ) |
Returns the description of the given error number.
[in] | error | The error number |
This function returns the description of an error that has been registered by eina_error_msg_register(). If an incorrect error is given, then NULL
is returned.
Referenced by efl::eina::error_category::message().
EAPI Eina_Error eina_error_find | ( | const char * | msg | ) |
Finds the Eina_Error corresponding to a message string.
[in] | msg | The error message string to match (NOT NULL ) |
msg
, otherwise 0
on failureThis function attempts to match msg
with its corresponding Eina_Error value. If no such value is found, 0
is returned.