Fapi_GetDescription(3)

✨ Fapi_GetDescription ✨

okay bestie, hiii 💖 this is the manual page for Fapi_GetDescription — yes, the name is literally the same as the thing, iconic of it honestly. It lives in the tpm2-tss library manual, and the whole vibe here is FAPI functions that let you pull the description back out of an object you already stashed away. Let's get into it 🎀

---

📖 SYNOPSIS

💅 Functions

TSS2_RC Fapi_GetDescription (FAPI_CONTEXT *context, char const *path,
    char **description)
TSS2_RC Fapi_GetDescription_Async (FAPI_CONTEXT *context, char const *path)
TSS2_RC Fapi_GetDescription_Finish (FAPI_CONTEXT *context, char **description)

🌸 Detailed Description

So the whole point of these: they're the FAPI functions that invoke GetDescription — and you can do it either as a one-call situation or in a whole asynchronous manner, whichever fits your main character energy ✨

---

🦋 Function Documentation

💜 TSS2_RC Fapi_GetDescription (FAPI_CONTEXT * context, char const * path, char ** description)

One-Call function for Fapi_GetDescription — literally the whole thing in one go, no follow-up needed 🫶

It returns the description of a previously stored object. That's it, that's the gig.

🌟 Parameters

• context — The FAPI_CONTEXT
• path — The path of the object for which the description is loaded
• description — The description of the object

🔥 Return values

• TSS2_RC_SUCCESS — if the function call was a success.
• TSS2_FAPI_RC_BAD_REFERENCE — if context, path or description 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_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.
• TSS2_FAPI_RC_GENERAL_FAILURE — if an internal error occurred.
• TSS2_FAPI_RC_NOT_PROVISIONED — FAPI was not provisioned.

---

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

Asynchronous function for Fapi_GetDescription — the "we'll do this later" version, lowkey so useful 😌

It returns the description of a previously stored object.

Call Fapi_GetDescription_Finish to finish the execution of this command. Don't leave it hanging bestie, it needs closure 💀

🌟 Parameters

• context — The FAPI_CONTEXT
• path — The path of the object for which the description is loaded

🔥 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_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_GetDescription_Finish (FAPI_CONTEXT * context, char ** description)

Asynchronous finish function for Fapi_GetDescription — the part where you actually collect your results 💅

This function should be called after a previous Fapi_GetDescription_Async. You started it, now finish it, periodt.

🌟 Parameters

• context — The FAPI_CONTEXT
• description — The description of the object

🔥 Return values

• TSS2_RC_SUCCESS — if the function call was a success.
• TSS2_FAPI_RC_BAD_REFERENCE — if context or description 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. (ngl this one is literally "not yet, bestie, check back in a sec" 🫠)
• 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. Not a human, just a very industrious little doc generator doing its thing 🤖💖

---

okay that's the whole page, no cap, nothing skipped 🫶 go get those descriptions bestie, the objects are waiting 🌈

tpm2-tss — Version 4.1.5 💖 bye diva, slay responsibly ✨💅