.TH "globus_generic_error_utility" 3 "Version 18.14" "globus_common" \" -*- nroff -*-
.ad l
.nh
.SH NAME
globus_generic_error_utility \- Error Handling Helpers
.PP
 \- Error Handling Helpers\&.  

.SH SYNOPSIS
.br
.PP
.SS "Error Match"

.in +1c
.ti -1c
.RI "\fBglobus_bool_t\fP \fBglobus_error_match\fP (globus_object_t *error, \fBglobus_module_descriptor_t\fP *module, int type)"
.br
.in -1c
.SS "Print Error Chain"

.in +1c
.ti -1c
.RI "char * \fBglobus_error_print_chain\fP (globus_object_t *error)"
.br
.in -1c
.SS "Print User Friendly Error Message"

.in +1c
.ti -1c
.RI "char * \fBglobus_error_print_friendly\fP (globus_object_t *error)"
.br
.in -1c
.SH "Detailed Description"
.PP 
Error Handling Helpers\&. 

Helper functions for dealing with Globus Generic Error objects\&.
.PP
This section defines utility functions for dealing with Globus Generic Error objects\&. 
.SH "Function Documentation"
.PP 
.SS "\fBglobus_bool_t\fP globus_error_match (globus_object_t * error, \fBglobus_module_descriptor_t\fP * module, int type)"
Check whether the error originated from a specific module and is of a specific type\&. <>
.PP
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\&.
.PP
\fBParameters\fP
.RS 4
\fIerror\fP The error object for which to perform the check 
.br
\fImodule\fP The module descriptor to check for 
.br
\fItype\fP The type to check for 
.RE
.PP
\fBReturns\fP
.RS 4
GLOBUS_TRUE - the error matched the module and type GLOBUS_FALSE - the error failed to match the module and type 
.RE
.PP

.SS "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\&. <>
.PP
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\&.
.PP
\fBParameters\fP
.RS 4
\fIerror\fP The error to print 
.RE
.PP
\fBReturns\fP
.RS 4
A string containing all printable errors\&. This string needs to be freed by the user of this function\&. 
.RE
.PP

.SS "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\&.
.PP
If the GLOBUS_ERROR_VERBOSE env is set, then the result from \fBglobus_error_print_chain()\fP will be used\&.
.PP
\fBParameters\fP
.RS 4
\fIerror\fP The error to print 
.RE
.PP
\fBReturns\fP
.RS 4
A string containing a friendly error message\&. This string needs to be freed by the user of this function\&. 
.RE
.PP

.SH "Author"
.PP 
Generated automatically by Doxygen for globus_common from the source code\&.