Fapi_SetDescription(3)

📦
version 4.1.5 · 8 versions
, in fedora 44

💅 Fapi_SetDescription(3) — the manual page, but make it iconic

okay bestie, so this page is from the Library Functions Manual — and it's literally all about Fapi_SetDescription. no cap, it's giving metadata glow-up energy. ✨

🫶 NAME

Fapi_SetDescription — because every object in your metadata store deserves a cute little human-readable description. periodt. 💖

✨ SYNOPSIS

TSS2_RC Fapi_SetDescription (FAPI_CONTEXT *context, char const *path,
    char const *description)
TSS2_RC Fapi_SetDescription_Async (FAPI_CONTEXT *context, char const *path,
    char const *description)
TSS2_RC Fapi_SetDescription_Finish (FAPI_CONTEXT *context)

🌸 DESCRIPTION (Detailed Description)

These are the FAPI functions that invoke SetDescription — either as a one-call situation or in an asynchronous manner. iykyk. 🦋

🎀 Function Documentation

⭐ TSS2_RC Fapi_SetDescription (FAPI_CONTEXT * context, char const * path, char const * description)

One-Call function for Fapi_SetDescription — the main character energy of this whole page. 👑

It associates a human readable description with an object in the metadata store. literally what it says on the tin. 💅

Parameters 🍓

  • context — The FAPI_CONTEXT
  • path — The path of the object in the metadata store
  • description — The description that is associated with the object. May be NULL

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_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_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_SetDescription_Async (FAPI_CONTEXT * context, char const * path, char const * description)

Asynchronous function for Fapi_SetDescription — because sometimes you gotta do things on your own timeline, bestie. ⏳

It associates a human readable description with an object in the metadata store. same vibe, different timing. 💜

Call Fapi_SetDescription_Finish to finish the execution of this command. don't leave it hanging, fr fr. 🫶

Parameters 🌈

  • context — The FAPI_CONTEXT
  • path — The path of the object in the metadata store
  • description — The description that is associated with the object. May be NULL

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_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_NOT_PROVISIONED FAPI was not provisioned.

🧚 TSS2_RC Fapi_SetDescription_Finish (FAPI_CONTEXT * context)

Asynchronous finish function for Fapi_SetDescription — the grand finale, the closing credits, the "okay we're done here" moment. 🎬

This function should be called after a previous Fapi_SetDescription_Async. like, you can't skip to the end without starting the movie, bestie. 🙈

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_PATH_NOT_FOUND If no file is found after pathname expansion.
  • 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_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. the machine did it, not me. 🤖✨

okay that's the whole page, bestie. this fabulous manual page was brought to you by tpm2-tss, Version 4.1.5, and it's dated Fapi_SetDescription(3) — slay. 💖🌸🦋

📦 where this page comes from