summaryrefslogtreecommitdiffstats
path: root/man/man3/TPMLIB_CancelCommand.pod
blob: b41efc24467881d0f8c66a663ca3738186e78e64 (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
=head1 NAME

TPMLIB_CancelCommand  - Cancel a TPM command

=head1 LIBRARY

TPM library (libtpms, -ltpms)

=head1 SYNOPSIS

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

B<uint32_t TPMLIB_CancelCommand(void);>

=head1 DESCRIPTION

The B<TPMLIB_CancelCommand()> function indicates that the ongoing processing
of a TPM command is to be cancelled. The cancellation will only
be effective for certain time consuming operations, such as the creation
of keys.

Note that an implementation that wants to support cancellation of commands
needs to process TPM commands in one thread and cancel them in another.

=head1 SEE ALSO

B<TPMLIB_Process>(3)

=cut