---
name: "Tspi_Context_GetTpmObject"
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_GetTpmObject"
---

# Tspi\_Context\_GetTpmObject(3)

get the handle of the TPM object associated with a context.

TCG Software Stack Developers Reference

## NAME

Context\_GetTpmObject - get the handle of the TPM object associated with a context.

## 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_GetTpmObject(TSS_HCONTEXT hContext, TSS_HTPM* phTPM);
```

## DESCRIPTION

**Tspi\_Context\_GetTpmObject** retrieves the TPM object of a context. Only one instance of this object exists for a given context and implicitly represents a TPM owner. This function is normally called at the beginning of a program, right after the context is established. You must have a context established prior to calling this function.

## PARAMETERS

### hContext

The *hContext* parameter is the handle of the context object (already existing).

### phTPM

The *phTPM* parameter is a pointer to where the handle of the TPM will be placed.

## RETURN CODES

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

- TSS\_E\_INVALID\_HANDLE

  *hContext* is not a valid handle.

- TSS\_E\_INTERNAL\_ERROR

  An internal SW error has been detected.

- TSS\_E\_BAD\_PARAMETER

  One or more of the parameters is incorrect.

## CONFORMING TO

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

## SEE ALSO

[**Tspi\_Context\_Create**(3)](/Tspi_Context_Create/3.md), [**Tspi\_Context\_Connect**(3)](/Tspi_Context_Connect/3.md), [**Tspi\_Context\_FreeMemory**(3)](/Tspi_Context_FreeMemory/3.md), [**Tspi\_Context\_Close**(3)](/Tspi_Context_Close/3.md).