logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

globus_generic_error_utility - Error Handling Helpers

Author

       Generated automatically by Doxygen for globus_common from the source code.

globus_common                                     Version 18.14                  globus_generic_error_utility(3)

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.

Function Documentation

globus_bool_tglobus_error_match(globus_object_t*error,globus_module_descriptor_t*module,inttype)
       Check whether the error originated from a specific module and is of a specific type. <>

       This function checks whether the error or any of it's 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.

       Parameterserror 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(globus_object_t*error)
       Return a string containing all printable errors found in a error object and it's 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.

       Parameterserror The error to print

       Returns
           A string containing all printable errors. This string needs to be freed by the user of this function.

   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.

       Parameterserror The error to print

       Returns
           A string containing a friendly error message. This string needs to be freed by the user of this
           function.

Name

       globus_generic_error_utility - Error Handling Helpers

        - Error Handling Helpers.

Synopsis

ErrorMatchglobus_bool_tglobus_error_match (globus_object_t *error, globus_module_descriptor_t *module, int type)

   PrintErrorChain
       char * globus_error_print_chain (globus_object_t *error)

   PrintUserFriendlyErrorMessage
       char * globus_error_print_friendly (globus_object_t *error)

See Also