.TH "globus_openssl_error_utility" 3 "Tue Jul 5 2022" "Version 4.4" "globus_gsi_openssl_error" \" -*- nroff -*-
.ad l
.nh
.SH NAME
globus_openssl_error_utility \- Error Object Helper Functions
.PP
 \- Error Object Helper Functions\&.  

.SH SYNOPSIS
.br
.PP
.SS "Functions"

.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
.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 
Error Object Helper Functions\&. 

The functions in the \fBError Object Helper Functions \fP section deal with Globus error objects constructed with OpenSSL error data\&. These functions manipulate the generic globus_object_t representation of an OpenSSL error\&. 
.SH "Function Documentation"
.PP 
.SS "globus_bool_t globus_error_match_openssl_error (globus_object_t * error, unsigned long library, unsigned long function, unsigned long reason)"
Check whether the error originated from a specific library, from a specific function and is of a specific type\&. <>
.PP
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
\fBReturn values\fP
.RS 4
\fIGLOBUS_TRUE\fP Error matched 
.br
\fIGLOBUS_FALSE\fP Error failed to match 
.RE
.PP

.SS "globus_object_t* globus_error_wrap_openssl_error (globus_module_descriptor_t * base_source, int error_type, const char * source_file, const char * source_func, int source_line, const char * format,  \&.\&.\&.)"
Wrap the OpenSSL error and create a wrapped globus error object from the error\&.
.PP
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 \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
\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\&.