.TH "Error Helper Functions" 3 "Wed Jan 25 2012" "Version 2.1" "globus gsi openssl error" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Error Helper Functions \- 
.SS "OpenSSL Error Match"

.in +1c
.ti -1c
.RI "globus_bool_t \fBglobus_error_match_openssl_error\fP (globus_object_t *error, unsigned long library, unsigned long function, unsigned long reason)"
.br
.in -1c
.SS "Wrap OpenSSL Error"

.in +1c
.ti -1c
.RI "globus_object_t * \fBglobus_error_wrap_openssl_error\fP (globus_module_descriptor_t *base_source, int error_type, const char *source_file, const char *source_func, int source_line, const char *format,\&.\&.\&.)"
.br
.in -1c
.SH "Detailed Description"
.PP 
Utility functions that deal with Globus OpenSSL Error objects\&. 

This section defines utility function for Globus OpenSSL Error objects\&. 
.SH "Function Documentation"
.PP 
.SS "globus_bool_t \fBglobus_error_match_openssl_error\fP (globus_object_t *error, unsigned longlibrary, unsigned longfunction, unsigned longreason)"
.PP
Check whether the error originated from a specific library, from a specific function and is of a specific type\&. This function checks whether the error or any of it's causative errors originated from a specific library, specific function and is of a specific type\&.
.PP
\fBParameters:\fP
.RS 4
\fIerror\fP The error object for which to perform the check 
.br
\fIlibrary\fP The library to check for 
.br
\fIfunction\fP The function to check for 
.br
\fIreason\fP The type to check for 
.RE
.PP
\fBReturns:\fP
.RS 4
GLOBUS_TRUE - the error matched GLOBUS_FALSE - the error failed to match 
.RE
.PP

.SS "globus_object_t* \fBglobus_error_wrap_openssl_error\fP (globus_module_descriptor_t *base_source, interror_type, const char *source_file, const char *source_func, intsource_line, const char *format, \&.\&.\&.)"
.PP
Wrap the OpenSSL error and create a wrapped globus error object from the error\&. This function gets all the openssl errors from the error list, and chains them using the globus error string object\&. The resulting globus error object is a wrapper to the openssl error at the end of the chain\&.
.PP
\fBParameters:\fP
.RS 4
\fIbase_source\fP The module that the error was generated from 
.br
\fIerror_type\fP The type of error encapsulating the openssl error 
.br
\fIsource_file\fP Name of file\&. Use __FILE__ 
.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 __LINE__ 
.br
\fIformat\fP format string for the description of the error entry point where the openssl error occurred, should be followed by parameters to fill the format string (like in printf)\&. 
.RE
.PP
\fBReturns:\fP
.RS 4
The globus error object\&. A globus_result_t object can be created using the globus_error_put function
.RE
.PP
\fBSee also:\fP
.RS 4
globus_error_put() 
.RE
.PP

.SH "Author"
.PP 
Generated automatically by Doxygen for globus gsi openssl error from the source code\&.