.TH "globus_gram_protocol_error_messages" 3 "Fri Nov 11 2016" "Version 12.15" "globus_gram_protocol" \" -*- nroff -*-
.ad l
.nh
.SH NAME
globus_gram_protocol_error_messages \- Error Messages
.PP
GRAM Error Messages Functions in this section handle converting GRAM error codes to strings which can help the user diagnose GRAM problems\&.  

.SS "Functions"

.in +1c
.ti -1c
.RI "const char * \fBglobus_gram_protocol_error_string\fP (int error_code)"
.br
.RI "Get a description of a a GRAM error code\&. "
.ti -1c
.RI "void \fBglobus_gram_protocol_error_7_hack_replace_message\fP (const char *message)"
.br
.RI "Replace the error message associated with error 7 with a custom message\&. "
.ti -1c
.RI "void \fBglobus_gram_protocol_error_10_hack_replace_message\fP (const char *message)"
.br
.RI "Replace the error message associated with error 10 with a custom message\&. "
.in -1c
.SH "Detailed Description"
.PP 
GRAM Error Messages Functions in this section handle converting GRAM error codes to strings which can help the user diagnose GRAM problems\&. 


.SH "Function Documentation"
.PP 
.SS "void globus_gram_protocol_error_10_hack_replace_message (const char * message)"

.PP
Replace the error message associated with error 10 with a custom message\&. The \fBglobus_gram_protocol_error_10_hack_replace_message()\fP function creates a custom version of the error message for the error \fIGLOBUS_GRAM_PROTOCOL_ERROR_PROTOCOL_FAILED\fP\&. The string pointed to by the \fImessage\fP parameter is copied to thread-local storage, and subsequent calls to \fBglobus_gram_protocol_error_string()\fP with this error number will return this copy of the string\&. Each time \fBglobus_gram_protocol_error_10_hack_replace_message()\fP is called for a particular thread, the previous message is freed\&.
.PP
The purpose of this function is to allow more meaningful error messages to be generated when protocol errors occur\&. In particular, the specific XIO error reason can be used in place of a generic protocol failure message\&.
.PP
\fBParameters:\fP
.RS 4
\fImessage\fP The new message to be associated with the GLOBUS_GRAM_PROTOCOL_ERROR_PROTOCOL_FAILED error code\&.
.RE
.PP
\fBNote:\fP
.RS 4
Since Globus 5\&.0\&.0, this function uses thread-specific storage, so that the value returned by \fBglobus_gram_protocol_error_string()\fP for GLOBUS_GRAM_PROTOCOL_ERROR_PROTOCOL_FAILED is that for the last authorization error where \fBglobus_gram_protocol_error_10_hack_replace_message()\fP was called from this thread\&. 
.RE
.PP

.SS "void globus_gram_protocol_error_7_hack_replace_message (const char * message)"

.PP
Replace the error message associated with error 7 with a custom message\&. The \fBglobus_gram_protocol_error_7_hack_replace_message()\fP function creates a custom version of the error message for the error \fIGLOBUS_GRAM_PROTOCOL_ERROR_AUTHORIZATION\fP\&. The string pointed to by the \fImessage\fP parameter is copied to thread-local storage, and subsequent calls to \fBglobus_gram_protocol_error_string()\fP with this error number will return this copy of the string\&. Each time \fBglobus_gram_protocol_error_7_hack_replace_message()\fP is called for a particular thread, the previous message is freed\&.
.PP
The purpose of this function is to allow more meaningful error messages to be generated when authentication failures occur\&. In particular, the specific GSSAPI error reason can be used in place of a generic authorization failure message\&.
.PP
\fBParameters:\fP
.RS 4
\fImessage\fP The new message to be associated with the GLOBUS_GRAM_PROTOCOL_ERROR_AUTHORIZATION error code\&.
.RE
.PP
\fBNote:\fP
.RS 4
Since Globus 5\&.0\&.0, this function uses thread-specific storage, so that the value returned by \fBglobus_gram_protocol_error_string()\fP for GLOBUS_GRAM_PROTOCOL_ERROR_AUTHORIZATION is that for the last authorization error where \fBglobus_gram_protocol_error_7_hack_replace_message()\fP was called from this thread\&. 
.RE
.PP

.SS "const char* globus_gram_protocol_error_string (int error_code)"

.PP
Get a description of a a GRAM error code\&. The \fBglobus_gram_protocol_error_string()\fP function takes a GRAM error code value and returns the associated error code string for the message\&. The string is statically allocated by the GRAM Protocol library and should not be modified or freed by the caller\&. The string is intended to complete a sentence of the form '[operation] failed because \&.\&.\&.'
.PP
\fBParameters:\fP
.RS 4
\fIerror_code\fP The error code to translate into a string\&.
.RE
.PP
\fBReturns:\fP
.RS 4
The \fBglobus_gram_protocol_error_string()\fP function returns a static string containing an explanation of the error\&. 
.RE
.PP

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