.\" 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_GetEventLog" 3 "2004-05-26" "TSS 1.1" "TCG Software Stack Developer's Reference"
.SH NAME
Tspi_TPM_GetEventLog\- get the entire PCR event log.
.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_GetEventLog(TSS_HTPM        " hTPM ", UINT32* " pulEventNumber ","
.BI "                                TSS_PCR_EVENT** " prgPcrEvents ");"
.fi
.sp
.ad
.hy

.SH "DESCRIPTION"
.PP
\fBTspi_TPM_GetEventLog\fR provides the whole event log that was used to create all of the PCRs. 
.SH "PARAMETERS"
.PP
.SS hTPM
Handle of the TPM object.
.PP 
.SS pulEventNumber
Receives number of returned event data structures in prgPcrEvents parameter.
.PP
.SS prgPcrEvents
Receives a pointer to an array of PCR event data.
If NULL, only the numberof elements is returned in pulEventNumber parameter.
.SH "RETURN CODES"
.PP
\fBTspi_TPM_GetEventLog\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_GetEventLog\fR conforms to the Trusted Computing Group Software Specification version 1.1 Golden
.SH "SEE ALSO"

.PP
\fBTspi_TPM_GetEvent\fR(3) \fBTspi_TPM_GetEvents\fR(3).