| 1 | =head1 NAME
|
|---|
| 2 |
|
|---|
| 3 | TPMLIB_VolatileAll_Store - store all volatile state of the TPM in a buffer
|
|---|
| 4 |
|
|---|
| 5 | =head1 LIBRARY
|
|---|
| 6 |
|
|---|
| 7 | TPM library (libtpms, -ltpms)
|
|---|
| 8 |
|
|---|
| 9 | =head1 SYNOPSIS
|
|---|
| 10 |
|
|---|
| 11 | B<#include <libtpms/tpm_library.h>>
|
|---|
| 12 |
|
|---|
| 13 | B<#include <libtpms/tpm_error.h>>
|
|---|
| 14 |
|
|---|
| 15 | B<TPM_RESULT TPMLIB_VolatileAll_Store(unsigned char **buffer,
|
|---|
| 16 | uint32_t *buflen);>
|
|---|
| 17 |
|
|---|
| 18 | =head1 DESCRIPTION
|
|---|
| 19 |
|
|---|
| 20 | The B<TPMLIB_VolatileAll_Store()> function is used to get the volatile
|
|---|
| 21 | state of the TPM. The function will allocate a I<buffer> and return
|
|---|
| 22 | the number of bytes of state information in the I<buflen> variable.
|
|---|
| 23 |
|
|---|
| 24 | =head1 ERRORS
|
|---|
| 25 |
|
|---|
| 26 | =over 4
|
|---|
| 27 |
|
|---|
| 28 | =item B<TPM_SUCCESS>
|
|---|
| 29 |
|
|---|
| 30 | The function completed successfully.
|
|---|
| 31 |
|
|---|
| 32 | =item B<TPM_FAIL>
|
|---|
| 33 |
|
|---|
| 34 | General failure.
|
|---|
| 35 |
|
|---|
| 36 | =back
|
|---|
| 37 |
|
|---|
| 38 | For a complete list of TPM error codes please consult the include file
|
|---|
| 39 | B<libtpms/tpm_error.h>
|
|---|
| 40 |
|
|---|
| 41 | =head1 SEE ALSO
|
|---|
| 42 |
|
|---|
| 43 | B<TPMLIB_MainInit>(3), B<TPMLIB_Terminate>(3), B<TPMLIB_RegisterCallbacks>(3)
|
|---|
| 44 |
|
|---|
| 45 | =cut
|
|---|
