.TH "globus_errno_error_object" 3 "Wed Feb 27 2019" "Version 18.2" "globus_common" \" -*- nroff -*-
.ad l
.nh
.SH NAME
globus_errno_error_object \- Error Construction\&.  

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

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

.in +1c
.ti -1c
.RI "globus_object_t * \fBglobus_error_construct_errno_error\fP (\fBglobus_module_descriptor_t\fP *base_source, globus_object_t *base_cause, const int system_errno)"
.br
.in -1c
.SS "Initialize Error"

.in +1c
.ti -1c
.RI "globus_object_t * \fBglobus_error_initialize_errno_error\fP (globus_object_t *error, \fBglobus_module_descriptor_t\fP *base_source, globus_object_t *base_cause, const int system_errno)"
.br
.in -1c
.SH "Detailed Description"
.PP 
Error Construction\&. 

Create and initialize a Globus Errno Error object\&.
.PP
This section defines operations to create and initialize Globus Errno Error objects\&. 
.SH "Macro Definition Documentation"
.PP 
.SS "#define GLOBUS_ERROR_TYPE_ERRNO"
Error type definition 
.SH "Function Documentation"
.PP 
.SS "globus_object_t* globus_error_construct_errno_error (\fBglobus_module_descriptor_t\fP * base_source, globus_object_t * base_cause, const int system_errno)"
Allocate and initialize an error of type GLOBUS_ERROR_TYPE_ERRNO
.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
\fIsystem_errno\fP The system errno\&. 
.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_errno_error (globus_object_t * error, \fBglobus_module_descriptor_t\fP * base_source, globus_object_t * base_cause, const int system_errno)"
Initialize a previously allocated error of type GLOBUS_ERROR_TYPE_ERRNO
.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
\fIsystem_errno\fP The system errno\&. 
.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

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