.TH "Error Construction" 3 "Sat Nov 8 2014" "Version 15.26" "globus_common" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Error Construction \- 
.SS "Macros"

.in +1c
.ti -1c
.RI "#define \fBGLOBUS_ERROR_TYPE_GLOBUS\fP"
.br
.in -1c
.SS "Construct Error"

.in +1c
.ti -1c
.RI "globus_object_t * \fBglobus_error_construct_error\fP (\fBglobus_module_descriptor_t\fP *base_source, globus_object_t *base_cause, int type, const char *source_file, const char *source_func, int source_line, const char *short_desc_format,\&.\&.\&.)"
.br
.ti -1c
.RI "globus_object_t * \fBglobus_error_v_construct_error\fP (\fBglobus_module_descriptor_t\fP *base_source, globus_object_t *base_cause, const int type, const char *source_file, const char *source_func, int source_line, const char *short_desc_format, va_list ap)"
.br
.in -1c
.SS "Initialize Error"

.in +1c
.ti -1c
.RI "globus_object_t * \fBglobus_error_initialize_error\fP (globus_object_t *error, \fBglobus_module_descriptor_t\fP *base_source, globus_object_t *base_cause, int type, const char *source_file, const char *source_func, int source_line, const char *short_desc_format, va_list ap)"
.br
.in -1c
.SH "Detailed Description"
.PP 
Create and initialize a Globus Generic Error object\&.
.PP
This section defines operations to create and initialize Globus Generic Error objects\&. 
.SH "Macro Definition Documentation"
.PP 
.SS "#define GLOBUS_ERROR_TYPE_GLOBUS"
Error type definition 
.SH "Function Documentation"
.PP 
.SS "globus_object_t* globus_error_construct_error (\fBglobus_module_descriptor_t\fP *base_source, globus_object_t *base_cause, inttype, const char *source_file, const char *source_func, intsource_line, const char *short_desc_format, \&.\&.\&.)"
Allocate and initialize an error of type GLOBUS_ERROR_TYPE_GLOBUS
.PP
\fBParameters:\fP
.RS 4
\fIbase_source\fP Pointer to the originating module\&. 
.br
\fIbase_cause\fP The error object causing the error\&. If this is the original error this parameter may be NULL\&. 
.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\&. 
.RE
.PP

.SS "globus_object_t* globus_error_initialize_error (globus_object_t *error, \fBglobus_module_descriptor_t\fP *base_source, globus_object_t *base_cause, inttype, const char *source_file, const char *source_func, intsource_line, const char *short_desc_format, va_listap)"
Initialize a previously allocated error of type GLOBUS_ERROR_TYPE_GLOBUS
.PP
\fBParameters:\fP
.RS 4
\fIerror\fP The previously allocated error object\&. 
.br
\fIbase_source\fP Pointer to the originating module\&. 
.br
\fIbase_cause\fP The error object causing the error\&. If this is the original error this parameter may be NULL\&. 
.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
\fIap\fP Arguments for the format string\&. 
.RE
.PP
\fBReturns:\fP
.RS 4
The resulting error object\&. You may have to call globus_error_put() on this object before passing it on\&. 
.RE
.PP

.SS "globus_object_t* globus_error_v_construct_error (\fBglobus_module_descriptor_t\fP *base_source, globus_object_t *base_cause, const inttype, const char *source_file, const char *source_func, intsource_line, const char *short_desc_format, va_listap)"
Allocate and initialize an error of type GLOBUS_ERROR_TYPE_GLOBUS
.PP
\fBParameters:\fP
.RS 4
\fIbase_source\fP Pointer to the originating module\&. 
.br
\fIbase_cause\fP The error object causing the error\&. If this is the original error this parameter may be NULL\&. 
.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
\fIap\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\&. 
.RE
.PP

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