.TH "globus_errno_error_utility" 3 "Version 18.14" "globus_common" \" -*- nroff -*-
.ad l
.nh
.SH NAME
globus_errno_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_errno_match\fP (globus_object_t *error, \fBglobus_module_descriptor_t\fP *module, int system_errno)"
.br
.ti -1c
.RI "int \fBglobus_error_errno_search\fP (globus_object_t *error)"
.br
.RI "Search for an errno value in an error chain <> "
.in -1c
.SS "Wrap Errno Error"

.in +1c
.ti -1c
.RI "globus_object_t * \fBglobus_error_wrap_errno_error\fP (\fBglobus_module_descriptor_t\fP *base_source, int system_errno, int type, const char *source_file, const char *source_func, int source_line, const char *short_desc_format,\&.\&.\&.)"
.br
.in -1c
.SH "Detailed Description"
.PP 
Error Handling Helpers\&. 

Helper functions for dealing with Globus Errno Error objects\&.
.PP
This section defines utility functions for dealing with Globus Errno Error objects\&. 
.SH "Function Documentation"
.PP 
.SS "\fBglobus_bool_t\fP globus_error_errno_match (globus_object_t * error, \fBglobus_module_descriptor_t\fP * module, int system_errno)"
Check whether the error originated from a specific module and matches a specific errno\&. <>
.PP
This function checks whether the error or any of it's causative errors originated from a specific module and contains a specific errno\&. If the module descriptor is left unspecified this function will check for any error of the specified errno 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
\fIsystem_errno\fP The errno to check for 
.RE
.PP
\fBReturns\fP
.RS 4
GLOBUS_TRUE - the error matched the module and errno GLOBUS_FALSE - the error failed to match the module and errno 
.RE
.PP

.SS "int globus_error_errno_search (globus_object_t * error)"

.PP
Search for an errno value in an error chain <> This function searches the error object and its causal errors for an error of type GLOBUS_ERROR_TYPE_ERRNO and returns the errno of that error\&. If the error and none of its causes are derived from that type, it returns 0\&.
.PP
\fBParameters\fP
.RS 4
\fIerror\fP The error object for which to perform the check 
.RE
.PP
\fBReturns\fP
.RS 4
This function returns 0 if no errorno is found, otherwise the error\&. 
.RE
.PP

.SS "globus_object_t * globus_error_wrap_errno_error (\fBglobus_module_descriptor_t\fP * base_source, int system_errno, int type, const char * source_file, const char * source_func, int source_line, const char * short_desc_format,  \&.\&.\&.)"
Allocate and initialize an error of type GLOBUS_ERROR_TYPE_GLOBUS which contains a causal error of type GLOBUS_ERROR_TYPE_ERRNO\&. <>
.PP
\fBParameters\fP
.RS 4
\fIbase_source\fP Pointer to the originating module\&. 
.br
\fIsystem_errno\fP The errno to use when generating the causal error\&. 
.br
\fItype\fP The error type\&. We may reserve part of this namespace for common errors\&. Errors not in this space are assumed to be local to the originating module\&. 
.br
\fIsource_file\fP Name of file\&. Use \fBFILE\fP 
.br
\fIsource_func\fP Name of function\&. Use _globus_func_name and declare your func with GlobusFuncName(<name>) 
.br
\fIsource_line\fP Line number\&. Use \fBLINE\fP 
.br
\fIshort_desc_format\fP Short format string giving a succinct description of the error\&. To be passed on to the user\&. 
.br
\fI\&.\&.\&.\fP Arguments for the format string\&. 
.RE
.PP
\fBReturns\fP
.RS 4
The resulting error object\&. It is the user's responsibility to eventually free this object using globus_object_free()\&. A globus_result_t may be obtained by calling globus_error_put() on this object\&. 
.br
 
.RE
.PP

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