summaryrefslogtreecommitdiff
path: root/man/man3/Tspi_TPM_GetEvent.3
diff options
context:
space:
mode:
Diffstat (limited to 'man/man3/Tspi_TPM_GetEvent.3')
-rw-r--r--man/man3/Tspi_TPM_GetEvent.380
1 files changed, 80 insertions, 0 deletions
diff --git a/man/man3/Tspi_TPM_GetEvent.3 b/man/man3/Tspi_TPM_GetEvent.3
new file mode 100644
index 0000000..5a5d77a
--- /dev/null
+++ b/man/man3/Tspi_TPM_GetEvent.3
@@ -0,0 +1,80 @@
+.\" Copyright (C) 2004 International Business Machines Corporation
+.\" Written by Kathy Robertson based on the Trusted Computing Group Software Stack Specification Version 1.1 Golden
+.\"
+.de Sh \" Subsection
+.br
+.if t .Sp
+.ne 5
+.PP
+\fB\\$1\fR
+.PP
+..
+.de Sp \" Vertical space (when we can't use .PP)
+.if t .sp .5v
+.if n .sp
+..
+.de Ip \" List item
+.br
+.ie \\n(.$>=3 .ne \\$3
+.el .ne 3
+.IP "\\$1" \\$2
+..
+.TH "Tspi_TPM_GetEvent" 3 "2004-05-26" "TSS 1.1" "TCG Software Stack Developer's Reference"
+.SH NAME
+Tspi_TPM_GetEvent\- get a PCR event for a given PCR index and event number.
+.SH "SYNOPSIS"
+.ad l
+.hy 0
+.nf
+.B #include <tss/platform.h>
+.B #include <tss/tcpa_defines.h>
+.B #include <tss/tcpa_typedef.h>
+.B #include <tss/tcpa_struct.h>
+.B #include <tss/tss_typedef.h>
+.B #include <tss/tss_structs.h>
+.B #include <tss/tspi.h>
+.sp
+.BI "TSS_RESULT Tspi_TPM_GetEvent(TSS_HTPM " hTPM ", UINT32 " ulPcrIndex ","
+.BI " UINT32 " ulEventNumber ", TSS_PCR_EVENT* " pPcrEvent ");"
+.fi
+.sp
+.ad
+.hy
+
+.SH "DESCRIPTION"
+.PP
+\fBTspi_TPM_GetEvent\fR provides a PCR event for a given PCR index and event number.
+.SH "PARAMETERS"
+.PP
+.SS hTPM
+Handle of the TPM object.
+.PP
+.SS ulPcrIndex
+Index of the PCR to request.
+.PP
+.SS ulEventNumber
+Index of the event to request.
+.PP
+.SS pPcrEvent
+Receives the PCR event data.
+.SH "RETURN CODES"
+.PP
+\fBTspi_TPM_GetEvent\fR returns TSS_SUCCESS on success, otherwise one of the following values are returned:
+.TP
+.SM TSS_E_INVALID_HANDLE
+\fBhTPM\fR is not a valid handle to the TPM object.
+.TP
+.SM TSS_E_INTERNAL_ERROR
+An error occurred internal to the TSS.
+
+.SH "CONFORMING TO"
+
+.PP
+\fBTspi_TPM_GetEvent\fR conforms to the Trusted Computing Group Software Specification version 1.1 Golden
+.SH "SEE ALSO"
+
+.PP
+\fBTspi_TPM_GetEvents\fR(3) \fBTspi_TPM_GetEventLog\fR(3).
+
+
+