.TH "globus_openssl_error_api" 3 "Wed Feb 27 2019" "Version 4.1" "globus_gsi_openssl_error" \" -*- nroff -*-
.ad l
.nh
.SH NAME
globus_openssl_error_api \- Globus OpenSSL Error API\&.  

.SH SYNOPSIS
.br
.PP
.SS "Modules"

.in +1c
.ti -1c
.RI "\fBActivation\fP"
.br
.RI "Activation\&. "
.ti -1c
.RI "\fBGlobus OpenSSL Error Object\fP"
.br
.RI "Globus OpenSSL Error Object\&. "
.ti -1c
.RI "\fBError Object Helper Functions\fP"
.br
.RI "Error Object Helper Functions\&. "
.in -1c
.SH "Detailed Description"
.PP 
Globus OpenSSL Error API\&. 

The globus_gsi_openssl_error functions provide a wrapper to error types defined by OpenSSL\&. The types and prototypes for the globus_gsi_openssl_error library are defined in the \fBglobus_error_openssl\&.h\fP header\&. Applications which use these functions must link with the libglobus_openssl_error library\&. The library is distributed with a pkg-config module called globus-gsi-openssl-error to automatically find header and library paths\&.
.SH "Library Initialization"
.PP
Activation\&. Globus GSI OpenSSL Error uses standard Globus module activation and deactivation\&. Before any Globus GSI OpenSSL Error functions are called, the following function must be called:
.PP
.PP
.nf
globus_module_activate(GLOBUS_GSI_OPENSSL_ERROR_MODULE)
.fi
.PP
.PP
This function returns GLOBUS_SUCCESS if Globus GSI OpenSSL Error was successfully initialized, and you are therefore allowed to subsequently call Globus GSI OpenSSL Error functions\&. Otherwise, an error code is returned, and Globus GSI OpenSSL Error functions should not be subsequently called\&. This function may be called multiple times\&.
.PP
To deactivate Globus GSI OpenSSL Error, the following function must be called:
.PP
.PP
.nf
globus_module_deactivate(GLOBUS_GSI_OPENSSL_ERROR_MODULE)
.fi
.PP
.PP
This function should be called once for each time Globus GSI OpenSSL Error was activated\&. 
.SH "Error Object Data Definition"
.PP
Globus OpenSSL Error Object\&. The globus_openssl_error_handle_t is an opaque structure pointer which contains information about the OpenSSL call which generated an error\&. The functions in the \fBGlobus OpenSSL Error Object \fP section of the API are used to create, manipulate, and destroy Globus OpenSSL Error object data\&. 
.SH "Error Object Manipulators"
.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 "Author"
.PP 
Generated automatically by Doxygen for globus_gsi_openssl_error from the source code\&.