---
name: "Fapi_GetDescription"
section: "3"
platform: "linux"
package: "tpm2-tss"
version: "4.2.0-2"
release: "Arch Linux 2026-11-01"
platforms: ["linux"]
url: "https://new.carta.tech/Fapi_GetDescription"
---

# Fapi\_GetDescription(3)

Fapi\_GetDescription

## NAME

Fapi\_GetDescription - Fapi\_GetDescription

## SYNOPSIS

### Functions

TSS2\_RC **Fapi\_GetDescription** (**FAPI\_CONTEXT** \*context, char const \*path, char \*\*description)\
 TSS2\_RC **Fapi\_GetDescription\_Async** (**FAPI\_CONTEXT** \*context, char const \*path)\
 TSS2\_RC **Fapi\_GetDescription\_Finish** (**FAPI\_CONTEXT** \*context, char \*\*description)\

## Detailed Description

FAPI functions to invoke GetDescription either as one-call or in an asynchronous manner.

## Function Documentation

### TSS2\_RC Fapi\_GetDescription (FAPI\_CONTEXT \* context, char const \* path, char \*\* description)

One-Call function for Fapi\_GetDescription

Returns the description of a previously stored object.

**Parameters**

*context* The **FAPI\_CONTEXT** \
 *path* The path of the object for which the description is loaded \
 *description* The description of the object

**Return values**

*TSS2\_RC\_SUCCESS* if the function call was a success. \
 *TSS2\_FAPI\_RC\_BAD\_REFERENCE* if context, path or description is NULL. \
 *TSS2\_FAPI\_RC\_BAD\_CONTEXT* if context corruption is detected. \
 *TSS2\_FAPI\_RC\_BAD\_PATH* if path does not map to a FAPI entity. \
 *TSS2\_FAPI\_RC\_BAD\_SEQUENCE* if the context has an asynchronous operation already pending. \
 *TSS2\_FAPI\_RC\_IO\_ERROR* if the data cannot be saved. \
 *TSS2\_FAPI\_RC\_MEMORY* if the FAPI cannot allocate enough memory for internal operations or return parameters. \
 *TSS2\_FAPI\_RC\_PATH\_NOT\_FOUND* if a FAPI object path was not found during authorization. \
 *TSS2\_FAPI\_RC\_KEY\_NOT\_FOUND* if a key was not found. \
 *TSS2\_FAPI\_RC\_BAD\_VALUE* if an invalid value was passed into the function. \
 *TSS2\_FAPI\_RC\_TRY\_AGAIN* if an I/O operation is not finished yet and this function needs to be called again. \
 *TSS2\_FAPI\_RC\_GENERAL\_FAILURE* if an internal error occurred. \
 *TSS2\_FAPI\_RC\_NOT\_PROVISIONED* FAPI was not provisioned.

### TSS2\_RC Fapi\_GetDescription\_Async (FAPI\_CONTEXT \* context, char const \* path)

Asynchronous function for Fapi\_GetDescription

Returns the description of a previously stored object.

Call Fapi\_GetDescription\_Finish to finish the execution of this command.

**Parameters**

*context* The **FAPI\_CONTEXT** \
 *path* The path of the object for which the description is loaded

**Return values**

*TSS2\_RC\_SUCCESS* if the function call was a success. \
 *TSS2\_FAPI\_RC\_BAD\_REFERENCE* if context or path is NULL. \
 *TSS2\_FAPI\_RC\_BAD\_CONTEXT* if context corruption is detected. \
 *TSS2\_FAPI\_RC\_BAD\_PATH* if path does not map to a FAPI entity. \
 *TSS2\_FAPI\_RC\_BAD\_SEQUENCE* if the context has an asynchronous operation already pending. \
 *TSS2\_FAPI\_RC\_IO\_ERROR* if the data cannot be saved. \
 *TSS2\_FAPI\_RC\_MEMORY* if the FAPI cannot allocate enough memory for internal operations or return parameters. \
 *TSS2\_FAPI\_RC\_PATH\_NOT\_FOUND* if a FAPI object path was not found during authorization. \
 *TSS2\_FAPI\_RC\_KEY\_NOT\_FOUND* if a key was not found. \
 *TSS2\_FAPI\_RC\_BAD\_VALUE* if an invalid value was passed into the function. \
 *TSS2\_FAPI\_RC\_NOT\_PROVISIONED* FAPI was not provisioned.

### TSS2\_RC Fapi\_GetDescription\_Finish (FAPI\_CONTEXT \* context, char \*\* description)

Asynchronous finish function for Fapi\_GetDescription

This function should be called after a previous Fapi\_GetDescription\_Async.

**Parameters**

*context* The **FAPI\_CONTEXT** \
 *description* The description of the object

**Return values**

*TSS2\_RC\_SUCCESS* if the function call was a success. \
 *TSS2\_FAPI\_RC\_BAD\_REFERENCE* if context or description is NULL. \
 *TSS2\_FAPI\_RC\_BAD\_CONTEXT* if context corruption is detected. \
 *TSS2\_FAPI\_RC\_BAD\_SEQUENCE* if the context has an asynchronous operation already pending. \
 *TSS2\_FAPI\_RC\_IO\_ERROR* if the data cannot be saved. \
 *TSS2\_FAPI\_RC\_MEMORY* if the FAPI cannot allocate enough memory for internal operations or return parameters. \
 *TSS2\_FAPI\_RC\_TRY\_AGAIN* if the asynchronous operation is not yet complete. Call this function again later. \
 *TSS2\_FAPI\_RC\_GENERAL\_FAILURE* if an internal error occurred. \
 *TSS2\_FAPI\_RC\_BAD\_VALUE* if an invalid value was passed into the function.

## Author

Generated automatically by Doxygen for tpm2-tss from the source code.