Fapi_Delete(3)

🎀 Fapi_Delete(3) — Library Functions Manual 🎀

okay bestie, this is the Fapi_Delete(3) page from the Library Functions Manual, and it's all about deleting stuff through FAPI. slay. 💅

🌸 NAME 🌸

Fapi_Delete — Fapi_Delete

✨ SYNOPSIS ✨

Functions:

TSS2_RC Fapi_Delete (FAPI_CONTEXT *context, char const *path)
TSS2_RC Fapi_Delete_Async (FAPI_CONTEXT *context, char const *path)
TSS2_RC Fapi_Delete_Finish (FAPI_CONTEXT *context)

💖 Detailed Description 💖

FAPI functions to invoke Delete either as one-call or in an asynchronous manner. iconic behavior honestly ✨

📚 Function Documentation 📚

TSS2_RC Fapi_Delete (FAPI_CONTEXT * context, char const * path)

One-Call function for Fapi_Delete.

Deletes a given key, policy or NV index from the system. 🗑️✨

Parameters

• context — The ESAPI_CONTEXT
• path — The path to the entity that is to be deleted

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 cannot be deleted.
• TSS2_FAPI_RC_NOT_DELETABLE — if the entity is not deletable or the path is read-only.
• 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_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_AUTHORIZATION_UNKNOWN — if a required authorization callback is not set.
• TSS2_FAPI_RC_AUTHORIZATION_FAILED — if the authorization attempt fails.
• TSS2_FAPI_RC_POLICY_UNKNOWN — if policy search for a certain policy digest was not successful.
• TSS2_ESYS_RC_* — possible error codes of ESAPI.
• TSS2_FAPI_RC_NOT_PROVISIONED — FAPI was not provisioned.

---

TSS2_RC Fapi_Delete_Async (FAPI_CONTEXT * context, char const * path)

Asynchronous function for Fapi_Delete.

Deletes a given key, policy or NV index from the system. 🗑️✨

Call Fapi_Delete_Finish to finish the execution of this command. iykyk 🫶

Parameters

• context — The ESAPI_CONTEXT
• path — The path to the entity that is to be deleted

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_NOT_DELETABLE — if the entity is not deletable or the path is read-only.
• 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_ESYS_RC_* — possible error codes of ESAPI.
• TSS2_FAPI_RC_NOT_PROVISIONED — FAPI was not provisioned.
• TSS2_FAPI_RC_GENERAL_FAILURE — if an internal error occurred.

---

TSS2_RC Fapi_Delete_Finish (FAPI_CONTEXT * context)

Asynchronous finish function for Fapi_Delete.

This function should be called after a previous Fapi_Delete_Async. the way that sequencing matters 😭✨

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_GENERAL_FAILURE — if an internal error occurred.
• TSS2_FAPI_RC_BAD_VALUE — if an invalid value was passed into the function.
• 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_AUTHORIZATION_UNKNOWN — if a required authorization callback is not set.
• TSS2_FAPI_RC_AUTHORIZATION_FAILED — if the authorization attempt fails.
• TSS2_FAPI_RC_POLICY_UNKNOWN — if policy search for a certain policy digest was not successful.
• TSS2_ESYS_RC_* — possible error codes of ESAPI.
• 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.

✍️ Author ✍️

Generated automatically by Doxygen for tpm2-tss from the source code. no cap, the robots wrote this one 🤖💖

---

with all the love from the source code, this cutie is tpm2-tss, Version 4.1.5 💖✨👑