---
name: "Fapi_List"
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_List"
---

# Fapi\_List(3)

Fapi\_List

## NAME

Fapi\_List - Fapi\_List

## SYNOPSIS

### Functions

TSS2\_RC **Fapi\_List** (**FAPI\_CONTEXT** \*context, char const \*searchPath, char \*\*pathList)\
 TSS2\_RC **Fapi\_List\_Async** (**FAPI\_CONTEXT** \*context, char const \*searchPath)\
 TSS2\_RC **Fapi\_List\_Finish** (**FAPI\_CONTEXT** \*context, char \*\*pathList)\

## Detailed Description

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

## Function Documentation

### TSS2\_RC Fapi\_List (FAPI\_CONTEXT \* context, char const \* searchPath, char \*\* pathList)

One-Call function for Fapi\_List

Enumerates all objects in the metadatastore in a fiven path and returns them in a list of complete paths from the root with the values separated by colons.

**Parameters**

*context* The **FAPI\_CONTEXT** \
 *searchPath* The path that identifies the root of the search \
 *pathList* A colon-separated list of all objects in the root path

**Return values**

*TSS2\_RC\_SUCCESS* if the function call was a success. \
 *TSS2\_FAPI\_RC\_BAD\_REFERENCE* if context, searchPath, pathlist is NULL. \
 *TSS2\_FAPI\_RC\_BAD\_CONTEXT* if context corruption is detected. \
 *TSS2\_FAPI\_RC\_BAD\_PATH* if searchPath 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\_NOT\_PROVISIONED* FAPI was not provisioned. \
 *TSS2\_FAPI\_RC\_BAD\_VALUE* if an invalid value was passed into the function.

### TSS2\_RC Fapi\_List\_Async (FAPI\_CONTEXT \* context, char const \* searchPath)

Asynchronous function for Fapi\_List

Enumerates all objects in the metadatastore in a fiven path and returns them in a list of complete paths from the root with the values separated by colons.

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

**Return values**

*TSS2\_RC\_SUCCESS* if the function call was a success.

**Parameters**

*context* The **FAPI\_CONTEXT** \
 *searchPath* The path that identifies the root of the search

**Return values**

*TSS2\_FAPI\_RC\_BAD\_REFERENCE* if context or searchPath is NULL. \
 *TSS2\_FAPI\_RC\_BAD\_CONTEXT* if context corruption is detected. \
 *TSS2\_FAPI\_RC\_BAD\_PATH* if searchPath 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\_RC Fapi\_List\_Finish (FAPI\_CONTEXT \* context, char \*\* pathList)

Asynchronous finish function for Fapi\_List

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

**Parameters**

*context* The **FAPI\_CONTEXT** \
 *pathList* A colon-separated list of all objects in the root path

**Return values**

*TSS2\_RC\_SUCCESS* if the function call was a success. \
 *TSS2\_FAPI\_RC\_BAD\_REFERENCE* if context or pathList 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\_PATH\_NOT\_FOUND* if a FAPI object path was not found during authorization. \
 *TSS2\_FAPI\_RC\_NOT\_PROVISIONED* FAPI was not provisioned. \
 *TSS2\_FAPI\_RC\_BAD\_PATH* if the path is used in inappropriate context or contains illegal characters. \
 *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.