Esys_GetTestResult(3)

💖 NAME 💖

okay so bestie, this is the Esys_GetTestResult(3) page from the Library Functions Manual, and the NAME section is short and iconic: Esys_GetTestResult — the ESAPI function for the TPM2_GetTestResult command. That's the whole vibe. 💅

✨ SYNOPSIS ✨

📚 Functions

TSS2_RC Esys_GetTestResult_Async (ESYS_CONTEXT *esysContext, ESYS_TR
    shandle1, ESYS_TR shandle2, ESYS_TR shandle3)
TSS2_RC Esys_GetTestResult (ESYS_CONTEXT *esysContext, ESYS_TR shandle1,
    ESYS_TR shandle2, ESYS_TR shandle3, TPM2B_MAX_BUFFER **outData,
    TPM2_RC *testResult)
TSS2_RC Esys_GetTestResult_Finish (ESYS_CONTEXT *esysContext,
    TPM2B_MAX_BUFFER **outData, TPM2_RC *testResult)

🌸 Detailed Description 🌸

ESAPI function to invoke the TPM2_GetTestResult command either as a one-call or in an asynchronous manner. Literally both modes, bestie — one-call or async, pick your main character energy. 🦋

🔥 Function Documentation 🔥

🫶 TSS2_RC Esys_GetTestResult (ESYS_CONTEXT * esysContext, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, TPM2B_MAX_BUFFER ** outData, TPM2_RC * testResult)

One-Call function for TPM2_GetTestResult

This one invokes the TPM2_GetTestResult command in a one-call variant. That means it will block until the TPM response is available, no cap. All input parameters are const. The memory for non-simple output parameters is allocated by the function implementation. 💖

📝 Parameters

• esysContext — The ESYS_CONTEXT.
• shandle1 — First session handle.
• shandle2 — Second session handle.
• shandle3 — Third session handle.
• outData — Test result data. (callee-allocated)
• testResult — . — yes, that is literally all the original page says here, so I am not inventing extra lore, bestie. 🙈

🎀 Return values

• TSS2_RC_SUCCESS — if the function call was a success. 💅
• TSS2_ESYS_RC_BAD_REFERENCE — if the esysContext or required input pointers or required output handle references are NULL.
• TSS2_ESYS_RC_BAD_CONTEXT — if esysContext corruption is detected.
• TSS2_ESYS_RC_MEMORY — if the ESAPI cannot allocate enough memory for internal operations or return parameters.
• TSS2_ESYS_RC_BAD_SEQUENCE — if the context has an asynchronous operation already pending.
• TSS2_ESYS_RC_INSUFFICIENT_RESPONSE — if the TPM's response does not at least contain the tag, response length, and response code.
• TSS2_ESYS_RC_MALFORMED_RESPONSE — if the TPM's response is corrupted.
• TSS2_ESYS_RC_RSP_AUTH_FAILED — if the response HMAC from the TPM did not verify.
• TSS2_ESYS_RC_MULTIPLE_DECRYPT_SESSIONS — if more than one session has the 'decrypt' attribute bit set.
• TSS2_ESYS_RC_MULTIPLE_ENCRYPT_SESSIONS — if more than one session has the 'encrypt' attribute bit set.
• TSS2_ESYS_RC_NO_DECRYPT_PARAM — if one of the sessions has the 'decrypt' attribute set and the command does not support encryption of the first command parameter.
• TSS2_RCs produced by lower layers of the software stack — may be returned to the caller unaltered unless handled internally.

🦋 TSS2_RC Esys_GetTestResult_Async (ESYS_CONTEXT * esysContext, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3)

Asynchronous function for TPM2_GetTestResult

This one invokes the TPM2_GetTestResult command in an asynchronous variant. It will return as soon as the command has been sent downwards the stack to the TPM. All input parameters are const. In order to retrieve the TPM's response, call Esys_GetTestResult_Finish. ⭐

📝 Parameters

• esysContext — The ESYS_CONTEXT.
• shandle1 — First session handle.
• shandle2 — Second session handle.
• shandle3 — Third session handle.

🎀 Return values

• ESYS_RC_SUCCESS — if the function call was a success.
• TSS2_ESYS_RC_BAD_REFERENCE — if the esysContext or required input pointers or required output handle references are NULL.
• TSS2_ESYS_RC_BAD_CONTEXT — if esysContext corruption is detected.
• TSS2_ESYS_RC_MEMORY — if the ESAPI cannot allocate enough memory for internal operations or return parameters.
• TSS2_RCs produced by lower layers of the software stack — may be returned to the caller unaltered unless handled internally.
• TSS2_ESYS_RC_MULTIPLE_DECRYPT_SESSIONS — if more than one session has the 'decrypt' attribute bit set.
• TSS2_ESYS_RC_MULTIPLE_ENCRYPT_SESSIONS — if more than one session has the 'encrypt' attribute bit set.
• TSS2_ESYS_RC_NO_DECRYPT_PARAM — if one of the sessions has the 'decrypt' attribute set and the command does not support encryption of the first command parameter.

🧚 TSS2_RC Esys_GetTestResult_Finish (ESYS_CONTEXT * esysContext, TPM2B_MAX_BUFFER ** outData, TPM2_RC * testResult)

Asynchronous finish function for TPM2_GetTestResult

This function returns the results of a TPM2_GetTestResult command invoked via Esys_GetTestResult_Finish. All non-simple output parameters are allocated by the function's implementation. NULL can be passed for every output parameter if the value is not required. 💜

📝 Parameters

• esysContext — The ESYS_CONTEXT.
• outData — Test result data. (callee-allocated)
• testResult — .

🎀 Return values

• TSS2_RC_SUCCESS — on success.
• ESYS_RC_SUCCESS — if the function call was a success.
• TSS2_ESYS_RC_BAD_REFERENCE — if the esysContext or required input pointers or required output handle references are NULL.
• TSS2_ESYS_RC_BAD_CONTEXT — if esysContext corruption is detected.
• TSS2_ESYS_RC_MEMORY — if the ESAPI cannot allocate enough memory for internal operations or return parameters.
• TSS2_ESYS_RC_BAD_SEQUENCE — if the context has an asynchronous operation already pending.
• TSS2_ESYS_RC_TRY_AGAIN — if the timeout counter expires before the TPM response is received.
• TSS2_ESYS_RC_INSUFFICIENT_RESPONSE — if the TPM's response does not at least contain the tag, response length, and response code.
• TSS2_ESYS_RC_RSP_AUTH_FAILED — if the response HMAC from the TPM did not verify.
• TSS2_ESYS_RC_MALFORMED_RESPONSE — if the TPM's response is corrupted.
• TSS2_RCs produced by lower layers of the software stack — may be returned to the caller unaltered unless handled internally.

🤖 Author 🤖

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

---

okay that's the whole page, bestie! The footer situation is tpm2-tss, Version 4.1.5, for Esys_GetTestResult(3) — and there's no separate date in the footer on this one, so no invented date, periodt. 💖✨🎀