Fapi_GetTcti.3 1.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849
  1. .TH "Fapi_GetTcti" 3 "Fri Oct 7 2022" "Version 3.2.0" "tpm2-tss" \" -*- nroff -*-
  2. .ad l
  3. .nh
  4. .SH NAME
  5. Fapi_GetTcti
  6. .SH SYNOPSIS
  7. .br
  8. .PP
  9. .SS "Functions"
  10. .in +1c
  11. .ti -1c
  12. .RI "TSS2_RC \fBFapi_GetTcti\fP (\fBFAPI_CONTEXT\fP *context, TSS2_TCTI_CONTEXT **tcti)"
  13. .br
  14. .in -1c
  15. .SH "Detailed Description"
  16. .PP
  17. FAPI function to retrieve the TSS2_TCTI_CONTEXT currently used by the corresponding \fBFAPI_CONTEXT\fP\&.
  18. .SH "Function Documentation"
  19. .PP
  20. .SS "Fapi_GetTcti (\fBFAPI_CONTEXT\fP * context, TSS2_TCTI_CONTEXT ** tcti)"
  21. One-Call function for Fapi_GetTcti
  22. .PP
  23. Fapi_GetTcti returns the TSS2_TCTI_CONTEXT currently used by the provided \fBFAPI_CONTEXT\fP\&. The purpose is to enable advanced access to the TPM that is currently being talked to\&. It is especially useful in combination with \fBFapi_GetTpmBlobs()\fP\&.
  24. .PP
  25. Note: The application must ensure that this TSS2_TCTI_CONTEXT is not being used in parallel to the processing of a FAPI command\&.
  26. .PP
  27. \fBParameters:\fP
  28. .RS 4
  29. \fIcontext\fP The \fBFAPI_CONTEXT\fP
  30. .br
  31. \fItcti\fP The TSS2_TCTI_CONTEXT used to talk to the current TPM\&.
  32. .RE
  33. .PP
  34. \fBReturn values:\fP
  35. .RS 4
  36. \fITSS2_RC_SUCCESS\fP if the function call was a success\&.
  37. .br
  38. \fITSS2_FAPI_RC_BAD_REFERENCE\fP if context, tcti is NULL\&.
  39. .br
  40. \fITSS2_FAPI_RC_BAD_CONTEXT\fP if context corruption is detected\&.
  41. .br
  42. \fITSS2_FAPI_RC_NO_TPM\fP if FAPI was started in non-TPM mode\&.
  43. .RE
  44. .PP
  45. .SH "Author"
  46. .PP
  47. Generated automatically by Doxygen for tpm2-tss from the source code\&.