---
name: "globus_gssapi_error_utility"
section: "3"
platform: "linux"
package: "libglobus-gssapi-error-doc"
version: "6.3-3"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/globus_gssapi_error_utility"
---

# globus\_gssapi\_error\_utility(3)

Error Handling Helpers - Error Handling Helpers.

## NAME

globus\_gssapi\_error\_utility - Error Handling Helpers

 \- Error Handling Helpers.

## SYNOPSIS

### Functions

globus\_bool\_t **globus\_error\_gssapi\_match** (globus\_object\_t \*error, globus\_module\_descriptor\_t \*module, const OM\_uint32 major\_status)\
 Error Match \<\>  globus\_object\_t \* **globus\_error\_wrap\_gssapi\_error** (globus\_module\_descriptor\_t \*base\_source, OM\_uint32 major\_status, OM\_uint32 minor\_status, int type, const char \*source\_file, const char \*source\_func, int source\_line, const char \*short\_desc\_format,...)\
 Wrap GSSAPI Error \<\>

## Detailed Description

Error Handling Helpers.

Helper functions for dealing with Globus GSSAPI Error objects.

This section defines utility functions for dealing with Globus GSSAPI Error objects.

## Function Documentation

### globus\_bool\_t globus\_error\_gssapi\_match (globus\_object\_t \* error, globus\_module\_descriptor\_t \* module, const OM\_uint32 major\_status)

Error Match \<\> Check whether the error originated from a specific module and match a specific major status.

This function checks whether the error or any of it's causative errors originated from a specific module and contains a specific major status. If the module descriptor is left unspecified this function will check for any error of the specified major\_status and vice versa.

**Parameters**

*error* The error object for which to perform the check \
 *module* The module descriptor to check for \
 *major\_status* The major status to check for

**Return values**

*GLOBUS\_TRUE* The error matched the module and major status \
 *GLOBUS\_FALSE* The error failed to match the module and major status

### globus\_object\_t \* globus\_error\_wrap\_gssapi\_error (globus\_module\_descriptor\_t \* base\_source, OM\_uint32 major\_status, OM\_uint32 minor\_status, int type, const char \* source\_file, const char \* source\_func, int source\_line, const char \* short\_desc\_format, ...)

Wrap GSSAPI Error \<\> Allocate and initialize an error of type GLOBUS\_ERROR\_TYPE\_GLOBUS which contains a causal error of type GLOBUS\_ERROR\_TYPE\_GSSAPI.

**Parameters**

*base\_source* Pointer to the originating module. \
 *major\_status* The major status to use when generating the causal error. \
 *minor\_status* The minor status to use when generating the causal error. \
 *type* The 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\_file* Name of file. Use **FILE** \
 *source\_func* Name of function. Use \_globus\_func\_name and declare your func with GlobusFuncName(\<name\>) \
 *source\_line* Line number. Use **LINE** \
 *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**

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. \

## Author

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