Fapi_GetInfo(3)

📦
version 4.1.5 · 8 versions
, in fedora 44

💅 Fapi_GetInfo — the Library Functions Manual page, but make it make sense 🎀

Okay bestie, so this is the Fapi_GetInfo(3) page from the Library Functions Manual and it's genuinely the most "just tell me what version of stuff I'm running" energy ever. No cap, it's short, it's sweet, and it comes in two flavours: the one-call version and the asynchronous girlie version 🦋

✨ NAME ✨

Fapi_GetInfo — literally just Fapi_GetInfo, she's an icon and she knows it 👑

🌸 SYNOPSIS 🌸

Here's the whole cast, in a Functions block, exactly as written:

TSS2_RC Fapi_GetInfo (FAPI_CONTEXT *context, char **info)
TSS2_RC Fapi_GetInfo_Async (FAPI_CONTEXT *context)
TSS2_RC Fapi_GetInfo_Finish (FAPI_CONTEXT *context, char **info)

💖 Detailed Description 💖

So basically these are the FAPI functions that invoke GetInfo — either as a one-call situation or in an asynchronous manner. Pick your lane, both are valid 💅

🧚 Function Documentation 🧚

⭐ TSS2_RC Fapi_GetInfo (FAPI_CONTEXT * context, char ** info)

The one-call function for Fapi_GetInfo — the "I want it now" option, main character energy fr fr.

It returns a UTF-8 encoded string that identifies the versions of FAPI, TPM, configurations and other relevant information. It's giving "receipts for my entire setup" 😭✨

🎀 Parameters

  • context — The FAPI_CONTEXT
  • info — The byte buffer for the information string

🔥 Return values

  • TSS2_RC_SUCCESS if the function call was a success.
  • TSS2_FAPI_RC_BAD_REFERENCE if context or info 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_NO_TPM if FAPI was initialized in no-TPM-mode via its config file.
  • 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_BAD_VALUE if an invalid value was passed into the function.
  • TSS2_ESYS_RC_* possible error codes of ESAPI.

🌈 TSS2_RC Fapi_GetInfo_Async (FAPI_CONTEXT * context)

The asynchronous function for Fapi_GetInfo — she works in the background, lowkey mysterious, we stan 🫶

Same deal as before: it returns a UTF-8 encoded string that identifies the versions of FAPI, TPM, configurations and other relevant information.

Bestie, listen: you must call Fapi_GetInfo_Finish to finish the execution of this command. Don't leave her hanging 💀

🎀 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_NO_TPM if FAPI was initialized in no-TPM-mode via its config file.

🦋 TSS2_RC Fapi_GetInfo_Finish (FAPI_CONTEXT * context, char ** info)

The asynchronous finish function</cvan> for Fapi_GetInfo — the "okay I'm back, here's your data" moment ✨

This function should be called after a previous Fapi_GetInfo_Async. Like, that's the whole point, she's the sequel 🌸

🎀 Parameters

  • context — The FAPI_CONTEXT
  • info — The byte buffer for the information string

🔥 Return values

  • TSS2_RC_SUCCESS if the function call was a success.
  • TSS2_FAPI_RC_BAD_REFERENCE if context or info 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_ESYS_RC_* possible error codes of ESAPI.

👑 Author 👑

Generated automatically by Doxygen for tpm2-tss from the source code. Not a human, but honestly? She ate 💅

tpm2-tss, Version 4.1.5, dated all the way back to Fapi_GetInfo(3) — that's the whole page bestie, go forth and check your versions 🎀💖✨

📦 where this page comes from