.TH "globus_gsi_authz_callout_error" 3 "Tue Jul 5 2022" "Version 4.2" "globus_authz_callout_error" \" -*- nroff -*-
.ad l
.nh
.SH NAME
globus_gsi_authz_callout_error \- GSI Authorization Callout Error API
.PP
 \- Authorization Callout Error Objects\&.  

.SH SYNOPSIS
.br
.PP
.SS "Macros"

.in +1c
.ti -1c
.RI "#define \fBGLOBUS_GSI_AUTHZ_CALLOUT_ERROR_MODULE\fP   (&globus_gsi_authz_callout_error_module)"
.br
.RI "Module descriptor\&. "
.ti -1c
.RI "#define \fBGLOBUS_GSI_AUTHZ_CALLOUT_ERROR\fP(__RESULT,  __TYPE,  __ERRSTR)"
.br
.RI "Create an authorization callout error object\&. "
.ti -1c
.RI "#define \fBGLOBUS_GSI_AUTHZ_CALLOUT_ERRNO_ERROR\fP(__RESULT,  __ERRNO)"
.br
.RI "Create an authorization callout error object with an errno\&. "
.in -1c
.SS "Enumerations"

.in +1c
.ti -1c
.RI "enum \fBglobus_gsi_authz_callout_error_t\fP { \fBGLOBUS_GSI_AUTHZ_CALLOUT_AUTHZ_CALLOUT_ERROR\fP = 0, \fBGLOBUS_GSI_AUTHZ_CALLOUT_AUTHZ_DENIED_BY_CALLOUT\fP = 1, \fBGLOBUS_GSI_AUTHZ_CALLOUT_CONFIGURATION_ERROR\fP = 2, \fBGLOBUS_GSI_AUTHZ_CALLOUT_SYSTEM_ERROR\fP = 3, \fBGLOBUS_GSI_AUTHZ_CALLOUT_CREDENTIAL_ERROR\fP = 4, \fBGLOBUS_GSI_AUTHZ_CALLOUT_BAD_ARGUMENT_ERROR\fP = 5, \fBGLOBUS_GSI_AUTHZ_CALLOUT_ERROR_LAST\fP = 6 }"
.br
.RI "Error codes\&. "
.in -1c
.SH "Detailed Description"
.PP 
Authorization Callout Error Objects\&. 

The GSI Authorization Callout Error API defines a set of Globus error codes which are used by the error objects generated by the GSI Authorization API\&. Applications or libraries that wish to use this interface must include the \fBglobus_gsi_authz_callout_error\&.h\fP header\&. 
.SH "Macro Definition Documentation"
.PP 
.SS "#define GLOBUS_GSI_AUTHZ_CALLOUT_ERRNO_ERROR(__RESULT, __ERRNO)"

.PP
Create an authorization callout error object with an errno\&. Update the __RESULT parameter to contain a new globus_result_t value pointing to an authorization error with the errno\&.
.PP
\fBParameters\fP
.RS 4
\fI__RESULT\fP A globus_result_t value pointing to a causal error\&. This will be modified by this macro to point to the new error object\&. 
.br
\fI__ERRNO\fP The errno value of this new error object\&. 
.RE
.PP

.SS "#define GLOBUS_GSI_AUTHZ_CALLOUT_ERROR(__RESULT, __TYPE, __ERRSTR)"

.PP
Create an authorization callout error object\&. Update the __RESULT parameter to contain a new globus_result_t value pointing to an authorization error of type __TYPE with the detail string __ERRSTR\&.
.PP
\fBParameters\fP
.RS 4
\fI__RESULT\fP A globus_result_t value pointing to a causal error\&. This will be modified by this macro to point to the new error object\&. 
.br
\fI__TYPE\fP The authorization error value from the globus_gsi_authz_callout_error_t enumeration\&. 
.br
\fI__ERRSTR\fP A parenthesized printf string containing the description of the error 
.RE
.PP

.SH "Enumeration Type Documentation"
.PP 
.SS "enum \fBglobus_gsi_authz_callout_error_t\fP"

.PP
Error codes\&. Error code types used by the GSI Authorization Callout API 
.PP
\fBEnumerator\fP
.in +1c
.TP
\fB\fIGLOBUS_GSI_AUTHZ_CALLOUT_AUTHZ_CALLOUT_ERROR \fP\fP
Authz callout error 
.TP
\fB\fIGLOBUS_GSI_AUTHZ_CALLOUT_AUTHZ_DENIED_BY_CALLOUT \fP\fP
Authorization denied by callout 
.TP
\fB\fIGLOBUS_GSI_AUTHZ_CALLOUT_CONFIGURATION_ERROR \fP\fP
Configuration Error 
.TP
\fB\fIGLOBUS_GSI_AUTHZ_CALLOUT_SYSTEM_ERROR \fP\fP
System Error 
.TP
\fB\fIGLOBUS_GSI_AUTHZ_CALLOUT_CREDENTIAL_ERROR \fP\fP
Credentials Error 
.TP
\fB\fIGLOBUS_GSI_AUTHZ_CALLOUT_BAD_ARGUMENT_ERROR \fP\fP
A invalid parameter was detected 
.SH "Author"
.PP 
Generated automatically by Doxygen for globus_authz_callout_error from the source code\&.