---
name: "Tspi_Context_LoadKeyByUUID"
section: "3"
platform: "linux"
package: "libtspi-dev"
version: "0.3.15-0.4"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/Tspi_Context_LoadKeyByUUID"
---

# Tspi\_Context\_LoadKeyByUUID(3)

load a key that's been registered in persistent storage.

## NAME

Tspi\_Context\_LoadKeyByUUID - load a key that's been registered in persistent storage.

## SYNOPSIS

```
#include <tss/platform.h>
#include <tss/tcpa_defines.h>
#include <tss/tcpa_typedef.h>
#include <tss/tcpa_struct.h>
#include <tss/tss_typedef.h>
#include <tss/tss_structs.h>
#include <tss/tspi.h>

TSS_RESULT Tspi_Context_LoadKeyByUUID(TSS_HCONTEXT hContext, TSS_FLAG persistentStorageType,
                                      TSS_UUID     uuidData, TSS_HKEY* phKey);
```

## DESCRIPTION

**TSS\_Context\_LoadKeyByUUID** creates a key object based on the information got from the manager using the UUID and loads the key into the TPM. The persistent storage provides all information to load the parent keys required to load the key associated with the given UUID.

## PARAMETERS

### hContext

The handle of the context object.

### persistentStorageType

Flag indicating the persistent storage the key is registered in. Should be either TSS\_PS\_TYPE\_USER ot TSS\_PS\_TYPE\_SYSTEM.

### uuidData

The UUID of the key by which the key was registered in the persistent storage (TSP or connected TCS).

### phKey

Receives the handle of the key object representing the loaded key.

## RETURN CODES

**Tspi\_Context\_LoadKeyByUUID** returns TSS\_SUCCESS on success, otherwise one of the following values are returned:

- TSS\_E\_INVALID\_HANDLE - *hContext* is an invalid handle.

  - TSS\_E\_BAD\_PARAMETER - *persistentStorageType* is not valid.

  - TSS\_E\_INTERNAL\_ERROR

  An error occurred internal to the TSS.

## CONFORMING TO

**Tspi\_Context\_LoadKeyByUUID** conforms to the Trusted Computing Group Software Specification version 1.1 Golden

## SEE ALSO

**[Tspi\_Context\_LoadKeyByBlob(3)](/Tspi_Context_LoadKeyByBlob/3.md)**, **[Tspi\_Key\_LoadKey(3)](/Tspi_Key_LoadKey/3.md)**.