.TH "globus_generic_error_accessor" 3 "Version 18.14" "globus_common" \" -*- nroff -*-
.ad l
.nh
.SH NAME
globus_generic_error_accessor \- Error Data Accessors and Modifiers
.PP
 \- Error Data Accessors and Modifiers\&.  

.SH SYNOPSIS
.br
.PP
.SS "Get Source"

.in +1c
.ti -1c
.RI "\fBglobus_module_descriptor_t\fP * \fBglobus_error_get_source\fP (globus_object_t *error)"
.br
.in -1c
.SS "Set Source"

.in +1c
.ti -1c
.RI "void \fBglobus_error_set_source\fP (globus_object_t *error, \fBglobus_module_descriptor_t\fP *source_module)"
.br
.in -1c
.SS "Get Cause"

.in +1c
.ti -1c
.RI "globus_object_t * \fBglobus_error_get_cause\fP (globus_object_t *error)"
.br
.in -1c
.SS "Set Cause"

.in +1c
.ti -1c
.RI "void \fBglobus_error_set_cause\fP (globus_object_t *error, globus_object_t *causal_error)"
.br
.in -1c
.SS "Get Type"

.in +1c
.ti -1c
.RI "int \fBglobus_error_get_type\fP (globus_object_t *error)"
.br
.in -1c
.SS "Set Type"

.in +1c
.ti -1c
.RI "void \fBglobus_error_set_type\fP (globus_object_t *error, const int type)"
.br
.in -1c
.SS "Get Short Description"

.in +1c
.ti -1c
.RI "char * \fBglobus_error_get_short_desc\fP (globus_object_t *error)"
.br
.in -1c
.SS "Set Short Description"

.in +1c
.ti -1c
.RI "void \fBglobus_error_set_short_desc\fP (globus_object_t *error, const char *short_desc_format,\&.\&.\&.)"
.br
.in -1c
.SS "Get Long Description"

.in +1c
.ti -1c
.RI "char * \fBglobus_error_get_long_desc\fP (globus_object_t *error)"
.br
.in -1c
.SS "Set Long Description"

.in +1c
.ti -1c
.RI "void \fBglobus_error_set_long_desc\fP (globus_object_t *error, const char *long_desc_format,\&.\&.\&.)"
.br
.in -1c
.SH "Detailed Description"
.PP 
Error Data Accessors and Modifiers\&. 

Get and set data in a Globus Generic Error object\&.
.PP
This section defines operations for accessing and modifying data in a Globus Generic Error object\&. 
.SH "Function Documentation"
.PP 
.SS "globus_object_t * globus_error_get_cause (globus_object_t * error)"
Retrieve the underlying error from a error object\&. <>
.PP
\fBParameters\fP
.RS 4
\fIerror\fP The error from which to retrieve the causative error\&. 
.RE
.PP
\fBReturns\fP
.RS 4
The underlying error object if it exists, NULL if it doesn't\&. 
.RE
.PP

.SS "char * globus_error_get_long_desc (globus_object_t * error)"
Retrieve the long error description from a generic globus error object\&. <>
.PP
\fBParameters\fP
.RS 4
\fIerror\fP The error from which to retrieve the description 
.RE
.PP
\fBReturns\fP
.RS 4
The long error description of the object 
.RE
.PP

.SS "char * globus_error_get_short_desc (globus_object_t * error)"
Retrieve the short error description from a generic globus error object\&. <>
.PP
\fBParameters\fP
.RS 4
\fIerror\fP The error from which to retrieve the description 
.RE
.PP
\fBReturns\fP
.RS 4
The short error description of the object 
.RE
.PP

.SS "\fBglobus_module_descriptor_t\fP * globus_error_get_source (globus_object_t * error)"
Retrieve the originating module descriptor from a error object\&. <>
.PP
\fBParameters\fP
.RS 4
\fIerror\fP The error from which to retrieve the module descriptor 
.RE
.PP
\fBReturns\fP
.RS 4
The originating module descriptor\&. 
.RE
.PP

.SS "int globus_error_get_type (globus_object_t * error)"
Retrieve the error type from a generic globus error object\&. <>
.PP
\fBParameters\fP
.RS 4
\fIerror\fP The error from which to retrieve the error type 
.RE
.PP
\fBReturns\fP
.RS 4
The error type of the object 
.RE
.PP

.SS "void globus_error_set_cause (globus_object_t * error, globus_object_t * causal_error)"
Set the causative error in a error object\&. <>
.PP
\fBParameters\fP
.RS 4
\fIerror\fP The error object for which to set the causative error\&. 
.br
\fIcausal_error\fP The causative error\&. 
.RE
.PP
\fBReturns\fP
.RS 4
void 
.RE
.PP

.SS "void globus_error_set_long_desc (globus_object_t * error, const char * long_desc_format,  \&.\&.\&.)"
Set the long error description in a generic globus error object\&. <>
.PP
\fBParameters\fP
.RS 4
\fIerror\fP The error object for which to set the description 
.br
\fIlong_desc_format\fP Longer format string giving a more detailed explanation of the error\&. 
.RE
.PP
\fBReturns\fP
.RS 4
void 
.RE
.PP

.SS "void globus_error_set_short_desc (globus_object_t * error, const char * short_desc_format,  \&.\&.\&.)"
Set the short error description in a generic globus error object\&. <>
.PP
\fBParameters\fP
.RS 4
\fIerror\fP The error object for which to set the description 
.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
void 
.RE
.PP

.SS "void globus_error_set_source (globus_object_t * error, \fBglobus_module_descriptor_t\fP * source_module)"
Set the originating module descriptor in a error object\&. <>
.PP
\fBParameters\fP
.RS 4
\fIerror\fP The error object for which to set the causative error 
.br
\fIsource_module\fP The originating module descriptor 
.RE
.PP
\fBReturns\fP
.RS 4
void 
.RE
.PP

.SS "void globus_error_set_type (globus_object_t * error, const int type)"
Set the error type in a generic globus error object\&. <>
.PP
\fBParameters\fP
.RS 4
\fIerror\fP The error object for which to set the error type 
.br
\fItype\fP The error type 
.RE
.PP
\fBReturns\fP
.RS 4
void 
.RE
.PP

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