---
name: "globus_gram_client_version"
section: "3"
platform: "linux"
package: "libglobus-gram-client-doc"
version: "14.6-3"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/globus_gram_client"
---

# globus\_gram\_client\_version(3)

GRAM Client API - GRAM Client API.

Part of [globus\_gram\_client(3)](/globus_gram_client/3.md).

## NAME

globus\_gram\_client - GRAM Client API

 \- GRAM Client API.

## SYNOPSIS

### Modules

**Job state callbacks**\
 Job state callbacks.  **GRAM Job Functions**\
 GRAM Job Functions.  **GRAM Client Attribute Functions**\
 GRAM Client Attribute Functions.

### Functions

void **globus\_gram\_client\_debug** (void)\
 Enable GRAM debugging.  int **globus\_gram\_client\_version** (void)\
 Return GRAM protocol version.  int **globus\_gram\_client\_set\_credentials** (gss\_cred\_id\_t new\_credentials)\
 Set the default GRAM credential.  const char \* **globus\_gram\_client\_error\_string** (int error\_code)\
 Get a description of a a GRAM error code.  int **globus\_gram\_client\_job\_contact\_free** (char \*job\_contact)\
 Free a job contact string.  void **globus\_gram\_client\_job\_info\_destroy** (**globus\_gram\_client\_job\_info\_t** \*info)\
 Free memory associated with a globus\_gram\_client\_job\_info\_t structure.

## Detailed Description

GRAM Client API.

The resource management API provides function for requesting that a job be started or terminated, as well as for requesting information about the status of a job.

## Function Documentation

### void globus\_gram\_client\_debug (void)

Enable GRAM debugging. The **globus\_gram\_client\_debug()** function enables the displaying of internal GRAM debug messages to standard output. Most of the information printed by this debugging system is related to errors that occur during GRAM Client API functions. The messages printed to standard output are not structured in any way.

### const char \* globus\_gram\_client\_error\_string (int error\_code)

Get a description of a a GRAM error code. The **globus\_gram\_client\_error\_string()** function takes a GRAM error code value and returns the associated error code string. The string is statically allocated by the Globus GRAM Client library and should not be modified or freed. The string is intended to complete a sentence of the form '\[operation\] failed because ...'

**Parameters**

*error\_code* The error code to translate into a string.

**Returns**

The **globus\_gram\_client\_error\_string()** function returns a static string containing an explanation of the error.

### int globus\_gram\_client\_job\_contact\_free (char \* job\_contact)

Free a job contact string. The **globus\_gram\_client\_job\_contact\_free()** function frees a job contact string that was allocated by a call to one of the functions in the **globus\_gram\_client\_job\_request()** family. The free() function can be used in place of this function. After this function returns, the string pointed to by the *job\_contact* parameter has an undefined value.

**Parameters**

*job\_contact* Pointer to a job contact string returned by a GRAM client API function.

**Returns**

This function always returns GLOBUS\_SUCCESS.

**Return values**

*GLOBUS\_SUCCESS* Success

### void globus\_gram\_client\_job\_info\_destroy (globus\_gram\_client\_job\_info\_t \* info)

Free memory associated with a globus\_gram\_client\_job\_info\_t structure. The **globus\_gram\_client\_job\_info\_destroy()** function frees data pointed to by the *extensions* and *job\_contact* fields of the *globus\_gram\_client\_job\_info\_t* structure pointed to by the *info* parameter.

**Parameters**

*info* A structure containing data to free.

### int globus\_gram\_client\_set\_credentials (gss\_cred\_id\_t new\_credentials)

Set the default GRAM credential. The **globus\_gram\_client\_set\_credentials()** function causes subsequent GRAM operations to use the GSSAPI credential *new\_credentials*. These operations include job requests, job signals, callback registration, and job state callbacks. After this function returns, the caller must not use the credential, as it may be freed by GRAM when it is no longer needed.

**Parameters**

*new\_credentials* New GSSAPI credential to use.

**Returns**

Upon success, **globus\_gram\_client\_set\_credentials()** returns GLOBUS\_SUCCESS. There are no error values returned by this fucntion.

**Return values**

*GLOBUS\_SUCCESS* Success

### int globus\_gram\_client\_version (void)

Return GRAM protocol version. The **globus\_gram\_client\_version()** function returns the version of the GRAM protocol understood by this implementation.

**Returns**

The integer protocol revision.

## Author

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