---
name: "Fapi_Initialize"
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_Initialize"
---

# Fapi\_Initialize(3)

Fapi\_Initialize

## NAME

Fapi\_Initialize - Fapi\_Initialize

## SYNOPSIS

### Functions

TSS2\_RC **Fapi\_Initialize** (**FAPI\_CONTEXT** \*\*context, char const \*uri)\
 TSS2\_RC **Fapi\_Initialize\_Async** (**FAPI\_CONTEXT** \*\*context, char const \*uri)\
 TSS2\_RC **Fapi\_Initialize\_Finish** (**FAPI\_CONTEXT** \*\*context)\

## Detailed Description

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

## Function Documentation

### TSS2\_RC Fapi\_Initialize (FAPI\_CONTEXT \*\* context, char const \* uri)

One-Call function for Fapi\_Initialize

Initializes a **FAPI\_CONTEXT** that holds all the state and metadata information during an interaction with the TPM.

**Parameters**

*context* The **FAPI\_CONTEXT** \
 *uri* Unused in this version of the FAPI. Must be NULL

**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\_VALUE* if uri is not NULL. \
 *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 an I/O operation is not finished yet and this function needs to be called again. \
 *TSS2\_FAPI\_RC\_BAD\_SEQUENCE* if the context has an asynchronous operation already pending. \
 *TSS2\_FAPI\_RC\_GENERAL\_FAILURE* if an internal error occurred. \
 *TSS2\_FAPI\_RC\_BAD\_PATH* if a path is used in inappropriate context or contains illegal characters. \
 *TSS2\_ESYS\_RC\_\** possible error codes of ESAPI.

### TSS2\_RC Fapi\_Initialize\_Async (FAPI\_CONTEXT \*\* context, char const \* uri)

Asynchronous function for Fapi\_Initialize

Initializes a **FAPI\_CONTEXT** that holds all the state and metadata information during an interaction with the TPM.

Call Fapi\_Initialize to finish the execution of this command.

**Parameters**

*context* The **FAPI\_CONTEXT** \
 *uri* Unused in this version of the FAPI. Must be NULL

**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\_VALUE* if uri is not NULL. \
 *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\_RC Fapi\_Initialize\_Finish (FAPI\_CONTEXT \*\* context)

Asynchronous finish function for Fapi\_Initialize

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

**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\_TRY\_AGAIN* if the asynchronous operation is not yet complete. Call this function again later. \
 *TSS2\_FAPI\_RC\_BAD\_VALUE* if an invalid value was passed into the function. \
 *TSS2\_FAPI\_RC\_GENERAL\_FAILURE* if an internal error occurred. \
 *TSS2\_FAPI\_RC\_BAD\_PATH* if a path is used in inappropriate context or contains illegal characters. \
 *TSS2\_ESYS\_RC\_\** possible error codes of ESAPI.

## Author

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