globus_gen...or_utility(3)

✨ NAME ✨

globus_generic_error_utility — Error Handling Helpers

• Error Handling Helpers.

okay bestie, welcome to globus_gen...or_utility(3) from the Library Functions Manual 💅 this is the page for the Globus Generic Error utility helpers — literally the helpers for dealing with Globus Generic Error objects and making their error chains make sense 🫶

---

✨ SYNOPSIS ✨

Error Match 🔍

globus_bool_t globus_error_match (globus_object_t *error,
    globus_module_descriptor_t *module, int type)

Print Error Chain 🎀

char * globus_error_print_chain (globus_object_t *error)

Print User Friendly Error Message 🦋

char * globus_error_print_friendly (globus_object_t *error)

---

✨ Detailed Description ✨

Error Handling Helpers.

Helper functions for dealing with Globus Generic Error objects.

This section defines utility functions for dealing with Globus Generic Error objects. no cap, it's all about the error objects and their little chain situation 💖

---

✨ Function Documentation ✨

globus_bool_t globus_error_match 🔥

globus_bool_t globus_error_match (globus_object_t * error,
    globus_module_descriptor_t * module, int type)

Check whether the error originated from a specific module and is of a specific type.

This function checks whether the error or any of its causative errors originated from a specific module and is of a specific type. If the module descriptor is left unspecified, this function will check for any error of the specified type and vice versa. it's giving "flexible but precise" ✨

Parameters

• error — The error object for which to perform the check
• module — The module descriptor to check for
• type — The type to check for

Returns

• GLOBUS_TRUE — the error matched the module and type
• GLOBUS_FALSE — the error failed to match the module and type

---

char * globus_error_print_chain 🌸

char * globus_error_print_chain (globus_object_t * error)

Return a string containing all printable errors found in an error object and its causative error chain.

If the GLOBUS_ERROR_VERBOSE env is set, file, line and function info will also be printed (where available). Otherwise, only the module name will be printed.

Parameters

• error — The error to print

Returns

A string containing all printable errors. This string needs to be freed by the user of this function. yes bestie, you gotta free it — that's the whole vibe check 🧚

---

char * globus_error_print_friendly 💖

char * globus_error_print_friendly (globus_object_t * error)

Return a string containing error messages from the top 1 and bottom 3 objects, and, if found, show a friendly error message. The error chain will be searched from top to bottom until a friendly handler is found and a friendly message is created.

If the GLOBUS_ERROR_VERBOSE env is set, then the result from globus_error_print_chain() will be used.

Parameters

• error — The error to print

Returns

A string containing a friendly error message. This string needs to be freed by the user of this function. seriously, free the string — no leaking memory in this group chat 😭💀

---

✨ Author ✨

Generated automatically by Doxygen for globus_common from the source code.

---

💖 footer vibe: globus_common, Version 18.15 — and there's no separate date listed on the footer, so that's the whole footer tea, periodt 🍓👑