.TH "globus_gssapi_error_utility" 3 "Version 6.3" "globus_gssapi_error" \" -*- nroff -*-
.ad l
.nh
.SH NAME
globus_gssapi_error_utility \- Error Handling Helpers
.PP
 \- Error Handling Helpers\&.  

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

.in +1c
.ti -1c
.RI "globus_bool_t \fBglobus_error_gssapi_match\fP (globus_object_t *error, globus_module_descriptor_t *module, const OM_uint32 major_status)"
.br
.RI "Error Match <> "
.ti -1c
.RI "globus_object_t * \fBglobus_error_wrap_gssapi_error\fP (globus_module_descriptor_t *base_source, OM_uint32 major_status, OM_uint32 minor_status, int type, const char *source_file, const char *source_func, int source_line, const char *short_desc_format,\&.\&.\&.)"
.br
.RI "Wrap GSSAPI Error <> "
.in -1c
.SH "Detailed Description"
.PP 
Error Handling Helpers\&. 

Helper functions for dealing with Globus GSSAPI Error objects\&.
.PP
This section defines utility functions for dealing with Globus GSSAPI Error objects\&. 
.SH "Function Documentation"
.PP 
.SS "globus_bool_t globus_error_gssapi_match (globus_object_t * error, globus_module_descriptor_t * module, const OM_uint32 major_status)"

.PP
Error Match <> Check whether the error originated from a specific module and match a specific major status\&.
.PP
This function checks whether the error or any of it's causative errors originated from a specific module and contains a specific major status\&. If the module descriptor is left unspecified this function will check for any error of the specified major_status 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
\fImajor_status\fP The major status to check for 
.RE
.PP
\fBReturn values\fP
.RS 4
\fIGLOBUS_TRUE\fP The error matched the module and major status 
.br
\fIGLOBUS_FALSE\fP The error failed to match the module and major status 
.RE
.PP

.SS "globus_object_t * globus_error_wrap_gssapi_error (globus_module_descriptor_t * base_source, OM_uint32 major_status, OM_uint32 minor_status, int type, const char * source_file, const char * source_func, int source_line, const char * short_desc_format,  \&.\&.\&.)"

.PP
Wrap GSSAPI Error <> Allocate and initialize an error of type GLOBUS_ERROR_TYPE_GLOBUS which contains a causal error of type GLOBUS_ERROR_TYPE_GSSAPI\&.
.PP
\fBParameters\fP
.RS 4
\fIbase_source\fP Pointer to the originating module\&. 
.br
\fImajor_status\fP The major status to use when generating the causal error\&. 
.br
\fIminor_status\fP The minor status 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_gssapi_error from the source code\&.