Copyright (C) 2004 International Business Machines Corporation
Written by Megan Schneider based on the Trusted Computing Group Software Stack Specification Version 1.1 Golden
Written by Megan Schneider based on the Trusted Computing Group Software Stack Specification Version 1.1 Golden
\\$1
.. ..
"\\$1" \\$2
..
"Tspi_TPM_GetStatus" 3 "2004-05-25" "TSS 1.1"
1 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_GetCapability(3).