---
name: "Esys_Load"
section: "3"
platform: "linux"
package: "tpm2-tss"
version: "4.2.0-2"
release: "Arch Linux 2026-11-01"
platforms: ["linux"]
url: "https://new.carta.tech/Esys_Load"
---

# Esys\_Load(3)

The ESAPI function for the TPM2\_Load command.

## NAME

Esys\_Load - The ESAPI function for the TPM2\_Load command.

## SYNOPSIS

### Functions

TSS2\_RC **Esys\_Load\_Async** (**ESYS\_CONTEXT** \*esysContext, **ESYS\_TR** parentHandle, **ESYS\_TR** shandle1, **ESYS\_TR** shandle2, **ESYS\_TR** shandle3, const TPM2B\_PRIVATE \*inPrivate, const TPM2B\_PUBLIC \*inPublic)\
 TSS2\_RC **Esys\_Load** (**ESYS\_CONTEXT** \*esysContext, **ESYS\_TR** parentHandle, **ESYS\_TR** shandle1, **ESYS\_TR** shandle2, **ESYS\_TR** shandle3, const TPM2B\_PRIVATE \*inPrivate, const TPM2B\_PUBLIC \*inPublic, **ESYS\_TR** \*objectHandle)\

## Detailed Description

ESAPI function to invoke the TPM2\_Load command either as a one-call or in an asynchronous manner.

## Function Documentation

### TSS2\_RC Esys\_Load (ESYS\_CONTEXT \* esysContext, ESYS\_TR parentHandle, ESYS\_TR shandle1, ESYS\_TR shandle2, ESYS\_TR shandle3, const TPM2B\_PRIVATE \* inPrivate, const TPM2B\_PUBLIC \* inPublic, ESYS\_TR \* objectHandle)

One-Call function for TPM2\_Load

This function invokes the TPM2\_Load command in a one-call variant. This means the function will block until the TPM response is available. All input parameters are const. The memory for non-simple output parameters is allocated by the function implementation.

**Parameters**

*esysContext* The **ESYS\_CONTEXT**. \
 *parentHandle* TPM handle of parent key; shall not be a reserved handle. \
 *shandle1* Session handle for authorization of parentHandle \
 *shandle2* Second session handle. \
 *shandle3* Third session handle. \
 *inPrivate* The private portion of the object. \
 *inPublic* The public portion of the object. \
 *objectHandle* **ESYS\_TR** handle of ESYS resource for TPM2\_HANDLE.

**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\_BAD\_TR* if any of the **ESYS\_TR** objects are unknown to the **ESYS\_CONTEXT** or are of the wrong type or if required **ESYS\_TR** objects are ESYS\_TR\_NONE. \
 *TSS2\_RCs* produced by lower layers of the software stack may be returned to the caller unaltered unless handled internally.

### TSS2\_RC Esys\_Load\_Async (ESYS\_CONTEXT \* esysContext, ESYS\_TR parentHandle, ESYS\_TR shandle1, ESYS\_TR shandle2, ESYS\_TR shandle3, const TPM2B\_PRIVATE \* inPrivate, const TPM2B\_PUBLIC \* inPublic)

Asynchronous function for TPM2\_Load

This function invokes the TPM2\_Load command in a asynchronous variant. This means the function 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\_Load\_Finish.

**Parameters**

*esysContext* The **ESYS\_CONTEXT**. \
 *parentHandle* TPM handle of parent key; shall not be a reserved handle. \
 *shandle1* Session handle for authorization of parentHandle \
 *shandle2* Second session handle. \
 *shandle3* Third session handle. \
 *inPrivate* The private portion of the object. \
 *inPublic* The public portion of the object.

**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\_BAD\_TR* if any of the **ESYS\_TR** objects are unknown to the **ESYS\_CONTEXT** or are of the wrong type or if required **ESYS\_TR** objects are ESYS\_TR\_NONE.

## Author

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