Fapi_SetAppData(3)

📦
version 4.1.5 · 8 versions
, in fedora 44

🌸 NAME 🌸

Okay bestie, welcome to Fapi_SetAppData(3) from the Library Functions Manual 💅 The name is literally Fapi_SetAppData — Fapi_SetAppData — and this page is all about that function and its little async crew. No cap.

✨ SYNOPSIS ✨

Functions

TSS2_RC Fapi_SetAppData (FAPI_CONTEXT *context, char const *path,
    uint8_t const *appData, size_t appDataSize)
TSS2_RC Fapi_SetAppData_Async (FAPI_CONTEXT *context, char const *path,
    uint8_t const *appData, size_t appDataSize)
TSS2_RC Fapi_SetAppData_Finish (FAPI_CONTEXT *context)

💅 Detailed Description 💅

These are the FAPI functions that invoke SetAppData either as a one-call situation or in an asynchronous manner. Two paths, same data-blob destiny ✨

🎀 Function Documentation 🎀

💖 TSS2_RC Fapi_SetAppData (FAPI_CONTEXT * context, char const * path, uint8_t const * appData, size_t appDataSize)

This is the one-call function for Fapi_SetAppData, periodt.

It associates an arbitrary data blob with a given object 🫶

Parameters

  • context — the FAPI_CONTEXT
  • path — the path to the object the blob is associated with
  • appData — the blob to associate with the object. May be NULL
  • appDataSize — the size of appData in bytes. Must be 0 if appData is NULL

Return values

  • TSS2_RC_SUCCESS — if the function call was a success
  • TSS2_FAPI_RC_BAD_REFERENCE — if context or path is NULL, or if appData is NULL and appDataSize is not 0
  • 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_SetAppData_Async (FAPI_CONTEXT * context, char const * path, uint8_t const * appData, size_t appDataSize)

The page literally labels this one one-call function for Fapi_SetAppData too — yes, even on the async one 😭 — but it is what it is, and we keep the details exactly.

It associates an arbitrary data blob with a given object 🌸

Call Fapi_SetAppData_Finish to finish the execution of this command. That's the whole vibe: start async, then finish it.

Parameters

  • context — the FAPI_CONTEXT
  • path — the path to the object the blob is associated with
  • appData — the blob to associate with the object. May be NULL
  • appDataSize — the size of appData in bytes. Must be 0 if appData is NULL

Return values

  • TSS2_RC_SUCCESS — if the function call was a success
  • TSS2_FAPI_RC_BAD_REFERENCE — if context or path is NULL, or if appData is NULL and appDataSize is not 0
  • 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_SetAppData_Finish (FAPI_CONTEXT * context)

This is the asynchronous finish function for Fapi_SetAppData, and it's giving cleanup era 💜

This function should be called after a previous Fapi_SetAppData_Async. Like, don't just leave your async operation hanging, 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_TRY_AGAIN — if the asynchronous operation is not yet complete. Call this function again later
  • 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
  • TSS2_FAPI_RC_PATH_NOT_FOUND — if a FAPI object path was not found during authorization

💖 Author 💖

Generated automatically by Doxygen for tpm2-tss from the source code. The original prose was auto-generated, but the group-chat energy is all me 😌✨

Okay that's the whole page, bestie 💖 — it's from tpm2-tss, Version 4.1.5, and the footer also echoes Fapi_SetAppData(3). Bye! 🦋🎀

📦 where this page comes from