Fapi_SetBranchCB(3)

πŸ’– Fapi_SetBranchCB: branch-picking callback realness πŸ’–

okay so bestie, this is the Fapi_SetBranchCB(3) page from the tpm2-tss Library Functions Manual. It's giving very specific callback energy, and we're keeping every single detail, no cap. πŸ’…


🌸 NAME 🌸

Fapi_SetBranchCB β€” Fapi_SetBranchCB


✨ SYNOPSIS ✨

πŸŽ€ Typedefs πŸŽ€

The typedef is right here, and yes, it's staying exactly as-is:

typedef TSS2_RC(* Fapi_CB_Branch) (char const *objectPath, char const
           *description, char const **branchNames, size_t numBranches, size_t
           *selectedBranch, void *userData)

πŸ¦‹ Functions πŸ¦‹

And here's the function, iconic:

TSS2_RC Fapi_SetBranchCB (FAPI_CONTEXT *context, Fapi_CB_Branch
       callback, void *userData)

πŸ’… Detailed Description πŸ’…

The detailed description is literally: FAPI functions to invoke SetBranchCB.


πŸ”₯ Function Documentation πŸ”₯

TSS2_RC Fapi_SetBranchCB

TSS2_RC Fapi_SetBranchCB (FAPI_CONTEXT * context, Fapi_CB_Branch callback,
       void * userData)

This function registers a callback that will be invoked whenever the FAPI has to decide which branch of a Policy-OR policy to use to authorize a particular FAPI operation.

πŸ’– Parameters πŸ’–

  • context β€” The FAPI_CONTEXT
  • callback β€” The callback function for branch selection
  • userData β€” A pointer that is provided to all callback invocations

πŸ“ Return values πŸ“

  • TSS2_RC_SUCCESS β€” if the function call was a success.
  • TSS2_FAPI_RC_BAD_REFERENCE β€” if the context is NULL.
  • TSS2_FAPI_RC_BAD_CONTEXT β€” if context corruption is detected.
  • TSS2_FAPI_RC_MEMORY β€” if the FAPI cannot allocate enough memory for internal operations or return parameters.
  • TSS2_FAPI_RC_BAD_SEQUENCE β€” if the synchronous or Async functions are called while the context has another asynchronous operation outstanding, or the Finish function is called while the context does not have an appropriate asynchronous operation outstanding.
  • TSS2_FAPI_RC_IO_ERROR β€” if the data cannot be saved.

πŸ‘‘ Author πŸ‘‘

Generated automatically by Doxygen for tpm2-tss from the source code.


okay bye bestie 🫢 the footer vibes are source: tpm2-tss, Version 4.1.5, and page: Fapi_SetBranchCB(3) β€” no date listed, so I'm not inventing one πŸ™ˆβœ¨πŸŽ€

πŸ“¦ where this page comes from