---
name: "Tspi_Hash_GetHashValue"
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_Hash_GetHashValue"
---

# Tspi\_Hash\_GetHashValue(3)

get the current hash value of a hash object

TCG Software Stack Developer's Reference

## NAME

Tspi\_Hash\_GetHashValue - get the current hash value of a hash object

## 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_Hash_GetHashValue(TSS_HHASH hHash, UINT32* pulHashValueLength, BYTE** prgbHashValue);
```

## DESCRIPTION

**Tspi\_Hash\_GetHashValue** gets the hash value of a hash object. **Tspi\_Context\_FreeMemory** must be used to clean up after this function, as memory is allocated for the *prgbHashValue* data.

## PARAMETERS

### hHash

The handle to the hash object instance whose hash value should be signed.

### pulHashValueLength

Receives the length of the hash value data returned at the parameter *prgbHashValue*.

### prgbHashValue

Receives a pointer to the hash value data.

## RETURN CODES

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

- TSS\_E\_INVALID\_HANDLE

  *hHash* 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.

- TSS\_E\_HASH\_INVALID\_LENGTH

  Hash length is inconsistent with hash algorithm.

- TSS\_E\_HASH\_NO\_DATA

  Hash object has no internal hash value.

## CONFORMING TO

**Tspi\_Hash\_GetHashValue** conforms to the Trusted Computing Group Software Specification version 1.1 Golden

## SEE ALSO

[**Tspi\_Hash\_UpdateHashValue**(3)](/Tspi_Hash_UpdateHashValue/3.md), [**Tspi\_Hash\_Sign**(3)](/Tspi_Hash_Sign/3.md), [**Tspi\_Hash\_VerifySignature**(3)](/Tspi_Hash_VerifySignature/3.md), [**Tspi\_Hash\_SetHashValue**(3)](/Tspi_Hash_SetHashValue/3.md).