---
name: "Fapi_GetInfo"
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_GetInfo"
---

# Fapi\_GetInfo(3)

Fapi\_GetInfo

## NAME

Fapi\_GetInfo - Fapi\_GetInfo

## SYNOPSIS

### Functions

TSS2\_RC **Fapi\_GetInfo** (**FAPI\_CONTEXT** \*context, char \*\*info)\
 TSS2\_RC **Fapi\_GetInfo\_Async** (**FAPI\_CONTEXT** \*context)\
 TSS2\_RC **Fapi\_GetInfo\_Finish** (**FAPI\_CONTEXT** \*context, char \*\*info)\

## Detailed Description

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

## Function Documentation

### TSS2\_RC Fapi\_GetInfo (FAPI\_CONTEXT \* context, char \*\* info)

One-Call function for Fapi\_GetInfo

Returns a UTF-8 encoded string that identifies the versions of FAPI, TPM, configurations and other relevant information.

**Parameters**

*context* The **FAPI\_CONTEXT** \
 *info* The byte buffer for the information string

**Return values**

*TSS2\_RC\_SUCCESS* if the function call was a success. \
 *TSS2\_FAPI\_RC\_BAD\_REFERENCE* if context or info 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\_NO\_TPM* if FAPI was initialized in no-TPM-mode via its config file. \
 *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\_BAD\_VALUE* if an invalid value was passed into the function. \
 *TSS2\_ESYS\_RC\_\** possible error codes of ESAPI.

### TSS2\_RC Fapi\_GetInfo\_Async (FAPI\_CONTEXT \* context)

Asynchronous function for Fapi\_GetInfo

Returns a UTF-8 encoded string that identifies the versions of FAPI, TPM, configurations and other relevant information.

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

**Parameters**

*context* The **FAPI\_CONTEXT**

**Return values**

*TSS2\_RC\_SUCCESS* if the function call was a success. \
 *TSS2\_FAPI\_RC\_BAD\_REFERENCE* if context 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\_NO\_TPM* if FAPI was initialized in no-TPM-mode via its config file.

### TSS2\_RC Fapi\_GetInfo\_Finish (FAPI\_CONTEXT \* context, char \*\* info)

Asynchronous finish function for Fapi\_GetInfo

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

**Parameters**

*context* The **FAPI\_CONTEXT** \
 *info* The byte buffer for the information string

**Return values**

*TSS2\_RC\_SUCCESS* if the function call was a success. \
 *TSS2\_FAPI\_RC\_BAD\_REFERENCE* if context or info 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. \
 *TSS2\_ESYS\_RC\_\** possible error codes of ESAPI.

## Author

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