Fapi_GetAppData(3)

💜 Fapi_GetAppData(3) — the tpm2-tss library functions manual, bestie edition

okay so welcome to the Fapi_GetAppData glow-up ✨ this is page three of the library functions manual, and yes we are literally about to get your object's appData out of the FAPI like it's a stashed note in a group chat 🎀

---

🌸 NAME 🌸

Fapi_GetAppData — bestie, it's literally Fapi_GetAppData, that's the whole name, no notes 💅

---

✨ SYNOPSIS ✨

🦋 Functions 🦋

TSS2_RC Fapi_GetAppData (FAPI_CONTEXT *context, char const *path,
    uint8_t **appData, size_t *appDataSize)
TSS2_RC Fapi_GetAppData_Async (FAPI_CONTEXT *context, char const *path)
TSS2_RC Fapi_GetAppData_Finish (FAPI_CONTEXT *context, uint8_t
    **appData, size_t *appDataSize)

---

🌈 Detailed Description 🌈

FAPI functions to invoke GetAppData either as a one-call or in an asynchronous manner. lowkey iconic of them to give you both options 🫶

---

👑 Function Documentation 👑

🎀 TSS2_RC Fapi_GetAppData (FAPI_CONTEXT * context, char const * path, uint8_t ** appData, size_t * appDataSize)

One-Call function for Fapi_GetAppData. one and done, no follow-up needed, main character energy fr fr 🔥

Every object has a description field that can be retrieved in order to obtain additional information in its "path" entry. like every object keeps a lil notes-app entry and this is how you read it 💖

Parameters

• context — The FAPI_CONTEXT
• path — The path to the object for which the appData is returned
• appData — A copy of the appData. May be NULL (callee-allocated)
• appDataSize — The size of the returned AppData. May be NULL

Return values

• TSS2_RC_SUCCESS — if the function call was a success. slay 💅
• TSS2_FAPI_RC_BAD_REFERENCE — if context or path is NULL.
• TSS2_FAPI_RC_BAD_CONTEXT — if context corruption is detected. uh oh 😭
• 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. one thing at a time bestie 🙈
• 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_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. it's giving "not yet, call me back" ⭐
• TSS2_FAPI_RC_GENERAL_FAILURE — if an internal error occurred. 💀
• TSS2_FAPI_RC_NOT_PROVISIONED — FAPI was not provisioned.

---

🧚 TSS2_RC Fapi_GetAppData_Async (FAPI_CONTEXT * context, char const * path)

Asynchronous function for Fapi_GetAppData. she's doing her own thing in the background, respect her process ✨

Every object has a description field that can be retrieved in order to obtain additional information in its "path" entry. same deal as the one-call version, no cap.

Call Fapi_GetAppData_Finish to finish the execution of this command. don't leave her hanging 🫶

Parameters

• context — The FAPI_CONTEXT
• path — The path to the object for which the appData is returned

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_NO_TPM — if FAPI was initialized in no-TPM-mode via its config file.
• 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_GetAppData_Finish (FAPI_CONTEXT * context, uint8_t ** appData, size_t * appDataSize)

Asynchronous finish function for Fapi_GetAppData. the grand finale, the reveal, the moment we've all been waiting for 🌟

This function should be called after a previous Fapi_GetAppData_Async.

Parameters

• context — The FAPI_CONTEXT
• appData — A copy of the appData. May be Null (callee-allocated)
• appDataSize — The size of the returned AppData. May be NULL

ok tiny detail bestie, the original really does capitalise it differently here — it says "May be Null" in this one and "May be NULL" in the other two. not me noticing that 🙈 keeping it exactly as written fr fr.

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. she's still cooking 🔥
• TSS2_FAPI_RC_BAD_PATH — if a path is used in inappropriate context or contains illegal characters.
• 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. the robots wrote it, we just gave it ✨aura✨

---

💜 and that's the whole page bestie — this is from tpm2-tss, Version 4.1.5, and the page is dated Fapi_GetAppData(3). go forth and get that appData, you absolute icon 👑🦋🌸