.TH "globus_error_api" 3 "Thu Jan 12 2017" "Version 16.9" "globus_common" \" -*- nroff -*-
.ad l
.nh
.SH NAME
globus_error_api
.SH SYNOPSIS
.br
.PP
.SS "Modules"

.in +1c
.ti -1c
.RI "\fBGlobus Errno Error API\fP"
.br
.ti -1c
.RI "\fBGlobus Generic Error API\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
Intended use:
.PP
If a function needs to return an error it should do the following:
.PP
.IP "\(bu" 2
External errors, such as error returns from system calls and GSSAPI errors, should be wrapped using the appropriate error type\&.
.IP "\(bu" 2
The wrapped external error should then be passed as the cause of a globus error\&.
.IP "\(bu" 2
External error types are expected to provide a utility function to combine the above two steps\&.
.IP "\(bu" 2
The globus error should then be returned from the function\&.
.PP
.PP
Notes on how to generate globus errors:
.PP
.IP "\(bu" 2
Module specific error types should be greater or equal to 1024 (to leave some space for global error types)\&.
.IP "\(bu" 2
You may wish to generate a mapping from error types to format strings for use in short descriptions\&.
.IP "\(bu" 2
You may also wish to generate a common prefix for all of the above fromat strings\&. The suggested prefix is 'Function: %s Line:
  %s '\&. 
.PP

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