ifapi_configuration.3 2.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576
  1. .TH "ifapi_configuration" 3 "Fri Oct 7 2022" "Version 3.2.0" "tpm2-tss" \" -*- nroff -*-
  2. .ad l
  3. .nh
  4. .SH NAME
  5. ifapi_configuration
  6. .SH SYNOPSIS
  7. .br
  8. .PP
  9. .SS "Functions"
  10. .in +1c
  11. .ti -1c
  12. .RI "TSS2_RC \fBifapi_config_initialize_async\fP (\fBIFAPI_IO\fP *io)"
  13. .br
  14. .ti -1c
  15. .RI "TSS2_RC \fBifapi_config_initialize_finish\fP (\fBIFAPI_IO\fP *io, \fBIFAPI_CONFIG\fP *config)"
  16. .br
  17. .in -1c
  18. .SH "Detailed Description"
  19. .PP
  20. Provides internal fapi functions for deserialization of the configuration data and the initialization of the configuration\&.
  21. .SH "Function Documentation"
  22. .PP
  23. .SS "TSS2_RC ifapi_config_initialize_async (\fBIFAPI_IO\fP * io)"
  24. Starts the initialization of the FAPI configuration\&.
  25. .PP
  26. \fBParameters:\fP
  27. .RS 4
  28. \fIio\fP An IO object for file system access
  29. .RE
  30. .PP
  31. \fBReturn values:\fP
  32. .RS 4
  33. \fITSS2_RC_SUCCESS\fP on success
  34. .br
  35. \fITSS2_FAPI_RC_BAD_REFERENCE\fP if io is NULL
  36. .br
  37. \fITSS2_FAPI_RC_IO_ERROR\fP if an error occurred while accessing the object store\&.
  38. .br
  39. \fITSS2_FAPI_RC_MEMORY\fP if not enough memory can be allocated\&.
  40. .RE
  41. .PP
  42. .SS "TSS2_RC ifapi_config_initialize_finish (\fBIFAPI_IO\fP * io, \fBIFAPI_CONFIG\fP * config)"
  43. Finishes the initialization of the FAPI configuration\&.
  44. .PP
  45. \fBParameters:\fP
  46. .RS 4
  47. \fIio\fP An IO object for file system access
  48. .br
  49. \fIconfig\fP The configuration that is initialized
  50. .RE
  51. .PP
  52. \fBReturn values:\fP
  53. .RS 4
  54. \fITSS2_RC_SUCCESS\fP on success
  55. .br
  56. \fITSS2_FAPI_RC_BAD_REFERENCE\fP if config or io is NULL
  57. .br
  58. \fITSS2_FAPI_RC_BAD_VALUE\fP if the read configuration file does not hold a valid configuration
  59. .br
  60. \fITSS2_FAPI_RC_GENERAL_FAILURE\fP if JSON parsing fails
  61. .br
  62. \fITSS2_FAPI_RC_BAD_PATH\fP if the configuration path is invalid
  63. .br
  64. \fITSS2_FAPI_RC_TRY_AGAIN\fP if an I/O operation is not finished yet and this function needs to be called again\&.
  65. .br
  66. \fITSS2_FAPI_RC_IO_ERROR\fP if an error occurred while accessing the object store\&.
  67. .br
  68. \fITSS2_FAPI_RC_MEMORY\fP if not enough memory can be allocated\&.
  69. .RE
  70. .PP
  71. .SH "Author"
  72. .PP
  73. Generated automatically by Doxygen for tpm2-tss from the source code\&.