---
name: "globus_error_set_type"
section: "3"
platform: "linux"
package: "libglobus-common-doc"
version: "18.14-3"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/globus_generic_error_accessor"
---

# globus\_error\_set\_type(3)

Error Data Accessors and Modifiers - Error Data Accessors and Modifiers.

Part of [globus\_generic\_error\_accessor(3)](/globus_generic_error_accessor/3.md).

## NAME

globus\_generic\_error\_accessor - Error Data Accessors and Modifiers

 \- Error Data Accessors and Modifiers.

## SYNOPSIS

### Get Source

**globus\_module\_descriptor\_t** \* **globus\_error\_get\_source** (globus\_object\_t \*error)\

### Set Source

void **globus\_error\_set\_source** (globus\_object\_t \*error, **globus\_module\_descriptor\_t** \*source\_module)\

### Get Cause

globus\_object\_t \* **globus\_error\_get\_cause** (globus\_object\_t \*error)\

### Set Cause

void **globus\_error\_set\_cause** (globus\_object\_t \*error, globus\_object\_t \*causal\_error)\

### Get Type

int **globus\_error\_get\_type** (globus\_object\_t \*error)\

### Set Type

void **globus\_error\_set\_type** (globus\_object\_t \*error, const int type)\

### Get Short Description

char \* **globus\_error\_get\_short\_desc** (globus\_object\_t \*error)\

### Set Short Description

void **globus\_error\_set\_short\_desc** (globus\_object\_t \*error, const char \*short\_desc\_format,...)\

### Get Long Description

char \* **globus\_error\_get\_long\_desc** (globus\_object\_t \*error)\

### Set Long Description

void **globus\_error\_set\_long\_desc** (globus\_object\_t \*error, const char \*long\_desc\_format,...)\

## Detailed Description

Error Data Accessors and Modifiers.

Get and set data in a Globus Generic Error object.

This section defines operations for accessing and modifying data in a Globus Generic Error object.

## Function Documentation

### globus\_object\_t \* globus\_error\_get\_cause (globus\_object\_t \* error)

Retrieve the underlying error from a error object. \<\>

**Parameters**

*error* The error from which to retrieve the causative error.

**Returns**

The underlying error object if it exists, NULL if it doesn't.

### char \* globus\_error\_get\_long\_desc (globus\_object\_t \* error)

Retrieve the long error description from a generic globus error object. \<\>

**Parameters**

*error* The error from which to retrieve the description

**Returns**

The long error description of the object

### char \* globus\_error\_get\_short\_desc (globus\_object\_t \* error)

Retrieve the short error description from a generic globus error object. \<\>

**Parameters**

*error* The error from which to retrieve the description

**Returns**

The short error description of the object

### globus\_module\_descriptor\_t \* globus\_error\_get\_source (globus\_object\_t \* error)

Retrieve the originating module descriptor from a error object. \<\>

**Parameters**

*error* The error from which to retrieve the module descriptor

**Returns**

The originating module descriptor.

### int globus\_error\_get\_type (globus\_object\_t \* error)

Retrieve the error type from a generic globus error object. \<\>

**Parameters**

*error* The error from which to retrieve the error type

**Returns**

The error type of the object

### void globus\_error\_set\_cause (globus\_object\_t \* error, globus\_object\_t \* causal\_error)

Set the causative error in a error object. \<\>

**Parameters**

*error* The error object for which to set the causative error. \
 *causal\_error* The causative error.

**Returns**

void

### void globus\_error\_set\_long\_desc (globus\_object\_t \* error, const char \* long\_desc\_format, ...)

Set the long error description in a generic globus error object. \<\>

**Parameters**

*error* The error object for which to set the description \
 *long\_desc\_format* Longer format string giving a more detailed explanation of the error.

**Returns**

void

### void globus\_error\_set\_short\_desc (globus\_object\_t \* error, const char \* short\_desc\_format, ...)

Set the short error description in a generic globus error object. \<\>

**Parameters**

*error* The error object for which to set the description \
 *short\_desc\_format* Short format string giving a succinct description of the error. To be passed on to the user. \
 *...* Arguments for the format string.

**Returns**

void

### void globus\_error\_set\_source (globus\_object\_t \* error, globus\_module\_descriptor\_t \* source\_module)

Set the originating module descriptor in a error object. \<\>

**Parameters**

*error* The error object for which to set the causative error \
 *source\_module* The originating module descriptor

**Returns**

void

### void globus\_error\_set\_type (globus\_object\_t \* error, const int type)

Set the error type in a generic globus error object. \<\>

**Parameters**

*error* The error object for which to set the error type \
 *type* The error type

**Returns**

void

## Author

Generated automatically by Doxygen for globus\_common from the source code.
