Provided by: libglobus-common-doc_18.13-2_all bug

NAME

       globus_errno_error_object - Error Construction

        - Error Construction.

SYNOPSIS

   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

       Error Construction.

       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 int system_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
           parameter 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 int
       system_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
           parameter 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.