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_Context_GetTpmObject" 3 "2004-05-25" "TSS 1.1"
24
TCG Software Stack Developers Reference
26
Context_GetTpmObject \- get the handle of the TPM object associated with a context.
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>
40
.BI "TSS_RESULT Tspi_Context_GetTpmObject(TSS_HCONTEXT " hContext ", TSS_HTPM* " phTPM "); "
48
\fBTspi_Context_GetTpmObject\fR retrieves the TPM object of a context. Only one instance of this
49
object exists for a given context and implicitly represents a TPM owner. This function is normally called at the beginning of a program, right after the context is established. You must have a context established prior to calling this function.
54
The \fIhContext\fR parameter is the handle of the context object
57
The \fIphTPM\fR parameter is a pointer to where the handle of the
62
\fBTspi_Context_GetTpmObject\fR returns TSS_SUCCESS on success,
63
otherwise one of the following values is returned:
65
.SM TSS_E_INVALID_HANDLE
66
\fIhContext\fR is not a valid handle.
69
.SM TSS_E_INTERNAL_ERROR
70
An internal SW error has been detected.
73
.SM TSS_E_BAD_PARAMETER
74
One or more of the parameters is incorrect.
79
\fBTspi_Context_GetTpmObject\fR conforms to the Trusted Computing Group
80
Software Specification version 1.1 Golden
85
\fBTspi_Context_Create\fR(3), \fBTspi_Context_Connect\fR(3), \fBTspi_Context_FreeMemory\fR(3), \fBTspi_Context_Close\fR(3).
added
removed
man/man3/Tspi_Context_GetTpmObject.3
