---
name: "Tspi_Context_GetKeyByUUID"
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_GetKeyByUUID"
---

# Tspi\_Context\_GetKeyByUUID(3)

get a handle to a key registered in persistent storage.

TCG Software Stack Developers Reference

## NAME

Tspi\_Context\_GetKeyByUUID - get a handle to a key 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_GetKeyByUUID(TSS_HCONTEXT hContext, TSS_FLAG  persistentStorageType,
                                     TSS_UUID     uuidData, TSS_HKEY* phKey);
```

## DESCRIPTION

**Tspi\_Context\_GetKeyByUUID** searches the Persistent Storage database for a registered key using the given UUID. It then creates a key object initialized to the found data and returns a handle to the key object.

## PARAMETERS

### hContext

The *hContext* parameter is the handle of the context object.

### persistentStorageType

The *persistentStorageType* parameter indicates the persistent storage the key is registered in.

### uuidData

The *uuidData* parameter is the UUID by which the key is registered in persistent storage.

### phKey

The *phKey* parameter receives the handle of the key object representing the key.

## RETURN CODES

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

- TSS\_E\_INVALID\_HANDLE

  *hContext* is an invalid handle.

- TSS\_E\_PS\_KEY\_NOTFOUND

  The key cannot be found in the persistent storage database.

- TSS\_E\_INTERNAL\_ERROR

  An internal SW error has been detected.

- TSS\_E\_BAD\_PARAMETER

  One or more parameters is bad.

## CONFORMING TO

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

## SEE ALSO

[**Tspi\_Context\_GetTpmObject**(3)](/Tspi_Context_GetTpmObject/3.md), [**Tspi\_Context\_LoadKeyByUUID**(3)](/Tspi_Context_LoadKeyByUUID/3.md), [**Tspi\_Context\_GetRegisteredKeysByUUID**(3)](/Tspi_Context_GetRegisteredKeysByUUID/3.md), [**Tspi\_Context\_GetKeyByPublicInfo**(3)](/Tspi_Context_GetKeyByPublicInfo/3.md).