Error Construction
Collaboration diagram for Error Construction:

Defines

Construct Error

Initialize Error


Detailed Description

Create and initialize a Globus Generic Error object.

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


Define Documentation

#define GLOBUS_ERROR_TYPE_GLOBUS

Error type definition.


Function Documentation

globus_object_t* globus_error_construct_error ( globus_module_descriptor_t *  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,
  ... 
)

Allocate and initialize an error of type GLOBUS_ERROR_TYPE_GLOBUS.

Parameters:
base_sourcePointer to the originating module.
base_causeThe error object causing the error. If this is the original error this paramater may be NULL.
typeThe 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.
source_fileName of file. Use __FILE__
source_funcName of function. Use _globus_func_name and declare your func with GlobusFuncName(<name>)
source_lineLine number. Use __LINE__
short_desc_formatShort format string giving a succinct description of the error. To be passed on to the user.
...Arguments for the format string.
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_v_construct_error ( globus_module_descriptor_t *  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 
)

Allocate and initialize an error of type GLOBUS_ERROR_TYPE_GLOBUS.

Parameters:
base_sourcePointer to the originating module.
base_causeThe error object causing the error. If this is the original error this paramater may be NULL.
typeThe 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.
source_fileName of file. Use __FILE__
source_funcName of function. Use _globus_func_name and declare your func with GlobusFuncName(<name>)
source_lineLine number. Use __LINE__
short_desc_formatShort format string giving a succinct description of the error. To be passed on to the user.
apArguments for the format string.
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_error ( globus_object_t *  error,
globus_module_descriptor_t *  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 
)

Initialize a previously allocated error of type GLOBUS_ERROR_TYPE_GLOBUS.

Parameters:
errorThe previously allocated error object.
base_sourcePointer to the originating module.
base_causeThe error object causing the error. If this is the original error this paramater may be NULL.
typeThe 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.
source_fileName of file. Use __FILE__
source_funcName of function. Use _globus_func_name and declare your func with GlobusFuncName(<name>)
source_lineLine number. Use __LINE__
short_desc_formatShort format string giving a succinct description of the error. To be passed on to the user.
apArguments for the format string.
Returns:
The resulting error object. You may have to call globus_error_put() on this object before passing it on.