---
name: "Tspi_TPM_GetStatus"
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_TPM_GetStatus"
---

# Tspi\_TPM\_GetStatus(3)

query the TPM's status

TCG Software Stack Developer's Reference

## NAME

Tspi\_TPM\_GetStatus - query the TPM's status

## 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_TPM_GetStatus(TSS_HTPM hTPM, TSS_FLAG statusFlag, BOOL* pfTpmState);
```

## DESCRIPTION

**Tspi\_TPM\_GetStatus** queries the status of the TPM, returning a specific status based on the flags specified. **This command is not currently implemented**.

## PARAMETERS

### hTPM

The *hTPM* parameter is used to specify the handle of the TPM object.

### statusFlag

The *statusFlag* parameter is the status to be retrieved.

### fTpmState

The *pfTpmState* parameter is a pointer to the value of the status queried.

## RETURN CODES

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

- TSS\_E\_INVALID\_HANDLE

  *hTPM* is not a valid handle.

- TSS\_E\_INTERNAL\_ERROR

  An internal SW error has been detected.

- TSS\_E\_BAD\_PARAMETER

  One or more parameters is bad.

## CONFORMING TO

**Tspi\_TPM\_GetStatus** conforms to the Trusted Computing Group Software Specification version 1.1 Golden

## SEE ALSO

[**Tspi\_TPM\_SetStatus**(3)](/Tspi_TPM_SetStatus/3.md), [**Tspi\_TPM\_GetCapability**(3)](/Tspi_TPM_GetCapability/3.md).