globus_generic_error_utility(3) [debian man page]
Error Handling Helpers(3) globus common Error Handling Helpers(3) NAME
Error Handling Helpers - 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 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_t globus_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. 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 (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. 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. 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. Author Generated automatically by Doxygen for globus common from the source code. Version 14.7 Tue Nov 27 2012 Error Handling Helpers(3)
Check Out this Related Man Page
Error Data Accessors and Modifiers(3) globus common Error Data Accessors and Modifiers(3) NAME
Error Data Accessors and Modifiers - Get Source globus_module_descriptor_t * globus_error_get_source (globus_object_t *error) Set Source void globus_error_set_source (globus_object_t *error, globus_module_descriptor_t *source_module) Get Cause globus_object_t * globus_error_get_cause (globus_object_t *error) Set Cause void globus_error_set_cause (globus_object_t *error, globus_object_t *causal_error) Get Type int globus_error_get_type (globus_object_t *error) Set Type void globus_error_set_type (globus_object_t *error, const int type) Get Short Description char * globus_error_get_short_desc (globus_object_t *error) Set Short Description void globus_error_set_short_desc (globus_object_t *error, const char *short_desc_format,...) Get Long Description char * globus_error_get_long_desc (globus_object_t *error) Set Long Description void globus_error_set_long_desc (globus_object_t *error, const char *long_desc_format,...) Detailed Description Get and set data in a Globus Generic Error object. This section defines operations for accessing and modifying data in a Globus Generic Error object. Function Documentation globus_module_descriptor_t* globus_error_get_source (globus_object_t *error) Retrieve the originating module descriptor from a error object. Parameters: error The error from which to retrieve the module descriptor Returns: The originating module descriptor. void globus_error_set_source (globus_object_t *error, globus_module_descriptor_t *source_module) Set the originating module descriptor in a error object. Parameters: error The error object for which to set the causative error source_module The originating module descriptor Returns: void globus_object_t* globus_error_get_cause (globus_object_t *error) Retrieve the underlying error from a error object. Parameters: error The error from which to retrieve the causative error. Returns: The underlying error object if it exists, NULL if it doesn't. void globus_error_set_cause (globus_object_t *error, globus_object_t *causal_error) Set the causative error in a error object. Parameters: error The error object for which to set the causative error. causal_error The causative error. Returns: void int globus_error_get_type (globus_object_t *error) Retrieve the error type from a generic globus error object. Parameters: error The error from which to retrieve the error type Returns: The error type of the object void globus_error_set_type (globus_object_t *error, const inttype) Set the error type in a generic globus error object. Parameters: error The error object for which to set the error type type The error type Returns: void char* globus_error_get_short_desc (globus_object_t *error) Retrieve the short error description from a generic globus error object. Parameters: error The error from which to retrieve the description Returns: The short error description of the object void globus_error_set_short_desc (globus_object_t *error, const char *short_desc_format, ...) Set the short error description in a generic globus error object. Parameters: error The error object for which to set the description short_desc_format Short format string giving a succinct description of the error. To be passed on to the user. ... Arguments for the format string. Returns: void char* globus_error_get_long_desc (globus_object_t *error) Retrieve the long error description from a generic globus error object. Parameters: error The error from which to retrieve the description Returns: The long error description of the object void globus_error_set_long_desc (globus_object_t *error, const char *long_desc_format, ...) Set the long error description in a generic globus error object. Parameters: error The error object for which to set the description long_desc_format Longer format string giving a more detailed explanation of the error. Returns: void Author Generated automatically by Doxygen for globus common from the source code. Version 14.7 Tue Nov 27 2012 Error Data Accessors and Modifiers(3)