summaryrefslogtreecommitdiffstats
path: root/man/man3/TPMLIB_VolatileAll_Store.pod
blob: 8906e1887e7bf6e86283ae40df0ab40594ead3c7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
=head1 NAME

TPMLIB_VolatileAll_Store   - store all volatile state of the TPM in a buffer

=head1 LIBRARY

TPM library (libtpms, -ltpms)

=head1 SYNOPSIS

B<#include <libtpms/tpm_library.h>>

B<#include <libtpms/tpm_error.h>>

B<TPM_RESULT TPMLIB_VolatileAll_Store(unsigned char **buffer,
                                   uint32_t *buflen);>

=head1 DESCRIPTION

The B<TPMLIB_VolatileAll_Store()> function is used to get the volatile 
state of the TPM. The function will allocate a I<buffer> and return
the number of bytes of state information in the I<buflen> variable.

=head1 ERRORS

=over 4

=item B<TPM_SUCCESS>

The function completed successfully.

=item B<TPM_FAIL>

General failure.

=back

For a complete list of TPM error codes please consult the include file
B<libtpms/tpm_error.h>

=head1 SEE ALSO

B<TPMLIB_MainInit>(3), B<TPMLIB_Terminate>(3), B<TPMLIB_RegisterCallbacks>(3)

=cut