1
.\" Copyright (C) 2004 International Business Machines Corporation
2
.\" Written by Megan Schneider based on the Trusted Computing Group Software Stack Specification Version 1.1 Golden
12
.de Sp \" Vertical space (when we can't use .PP)
18
.ie \\n(.$>=3 .ne \\$3
22
.TH "Tspi_Hash_GetHashValue" 3 "2004-05-25" "TSS 1.1"
24
TCG Software Stack Developer's Reference
26
Tspi_Hash_GetHashValue \- get the current hash value of a hash object
31
.B #include <tss/platform.h>
32
.B #include <tss/tcpa_defines.h>
33
.B #include <tss/tcpa_typedef.h>
34
.B #include <tss/tcpa_struct.h>
35
.B #include <tss/tss_typedef.h>
36
.B #include <tss/tss_structs.h>
37
.B #include <tss/tspi.h>
39
.BI "TSS_RESULT Tspi_Hash_GetHashValue(TSS_HHASH " hHash ", UINT32* " pulHashValueLength ", BYTE** " prgbHashValue ");"
47
\fBTspi_Hash_GetHashValue\fR gets the hash value of
48
a hash object. \fBTspi_Context_FreeMemory\fR must be used to clean
49
up after this function, as memory is allocated for the
50
\fIprgbHashValue\fR data.
55
The handle to the hash object instance whose hash value should be signed.
56
.SS pulHashValueLength
57
Receives the length of the hash value data returned at the parameter
60
Receives a pointer to the hash value data.
64
\fBTspi_Hash_GetHashValue\fR returns TSS_SUCCESS on success, otherwise
65
one of the following values is returned:
67
.SM TSS_E_INVALID_HANDLE
68
\fIhHash\fR is not a valid handle.
71
.SM TSS_E_INTERNAL_ERROR
72
An internal SW error has been detected.
75
.SM TSS_E_BAD_PARAMETER
76
One or more parameters is bad.
79
.SM TSS_E_HASH_INVALID_LENGTH
80
Hash length is inconsistent with hash algorithm.
83
.SM TSS_E_HASH_NO_DATA
84
Hash object has no internal hash value.
90
\fBTspi_Hash_GetHashValue\fR conforms to the Trusted Computing Group
91
Software Specification version 1.1 Golden
96
\fBTspi_Hash_UpdateHash\fR(3), \fBTspi_Hash_Sign\fR(3),
97
\fBTspi_Hash_VerifySignature\fR(3), \fBTspi_Hash_SetHashValue\fR(3).