debian man page for globus_errno_error_object

Error Construction(3)						   globus common					     Error Construction(3)

NAME
       Error Construction -

   Macros
       #define GLOBUS_ERROR_TYPE_ERRNO

   Construct Error
       globus_object_t * globus_error_construct_errno_error (globus_module_descriptor_t *base_source, globus_object_t *base_cause, const int
	   system_errno)

   Initialize Error
       globus_object_t * globus_error_initialize_errno_error (globus_object_t *error, globus_module_descriptor_t *base_source, globus_object_t
	   *base_cause, const int system_errno)

Detailed Description
       Create and initialize a Globus Errno Error object.

       This section defines operations to create and initialize Globus Errno Error objects.

Macro Definition Documentation
   #define GLOBUS_ERROR_TYPE_ERRNO
       Error type definition.

Function Documentation
   globus_object_t* globus_error_construct_errno_error (globus_module_descriptor_t *base_source, globus_object_t *base_cause, const
       intsystem_errno)
       Allocate and initialize an error of type GLOBUS_ERROR_TYPE_ERRNO. Parameters:
	   base_source Pointer to the originating module.
	   base_cause The error object causing the error. If this is the original error, this paramater may be NULL.
	   system_errno The system errno.

       Returns:
	   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.

   globus_object_t* globus_error_initialize_errno_error (globus_object_t *error, globus_module_descriptor_t *base_source, globus_object_t
       *base_cause, const intsystem_errno)
       Initialize a previously allocated error of type GLOBUS_ERROR_TYPE_ERRNO. Parameters:
	   error The previously allocated error object.
	   base_source Pointer to the originating module.
	   base_cause The error object causing the error. If this is the original error this paramater may be NULL.
	   system_errno The system errno.

       Returns:
	   The resulting error object. You may have to call globus_error_put() on this object before passing it on.

Author
       Generated automatically by Doxygen for globus common from the source code.

Version 14.7							  Tue Nov 27 2012					     Error Construction(3)