Fapi_List(3)

💅 Fapi_List(3) — the girlies' guide to listing your FAPI objects

okay so this is Fapi_List from the tpm2-tss Library Functions Manual and honestly it's giving "let me see everything in the metadatastore" energy ✨ buckle up bestie, we're learning today 🎀

---

🌸 NAME 🌸

Fapi_List — literally just Fapi_List, that's the name, no notes 💅

---

✨ 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 💜

these are the FAPI functions that let you invoke List — either the one-call way (slay, single function, done) or the asynchronous way (the "we're doing this in stages" vibe) 🫶

---

👑 Function Documentation 👑

⭐ TSS2_RC Fapi_List (FAPI_CONTEXT * context, char const * searchPath, char ** pathList)

One-Call function for Fapi_List — this is the main character fr fr 🔥

it enumerates all objects in the metadatastore in a given path and returns them in a list of complete paths from the root, with the values separated by colons. yes bestie, 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 — the "we'll get there when we get there" version 🦋

it enumerates all objects in the metadatastore in a given path and returns them in a list of complete paths from the root with the values separated by colons. same deal as the one-call version, just async ✨

call Fapi_List_Finish to finish the execution of this command — no leaving it half-done bestie 🫶

🎀 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 — the grand finale, the closing number, the periodt 💅

this function should be called after a previous Fapi_List_Async. that's it, that's the rule 📏

🎀 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 ⏳ (she's not ready yet, be patient bestie)
• 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 — she wasn't hand-written, she was born this way, iykyk 💫

---

and that's the whole page bestie!! mwah 💖 this iconic little number came to you from tpm2-tss, Version 4.1.5, page Fapi_List(3) — no cap, that's the source and version, go off 👑🌸