| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465 |
- .TH "Esys_Clear" 3 "Fri Oct 7 2022" "Version 3.2.0" "tpm2-tss" \" -*- nroff -*-
- .ad l
- .nh
- .SH NAME
- Esys_Clear
- .SH SYNOPSIS
- .br
- .PP
- .SS "Functions"
- .in +1c
- .ti -1c
- .RI "TSS2_RC \fBEsys_Clear_Async\fP (\fBESYS_CONTEXT\fP *esysContext, \fBESYS_TR\fP authHandle, \fBESYS_TR\fP shandle1, \fBESYS_TR\fP shandle2, \fBESYS_TR\fP shandle3)"
- .br
- .in -1c
- .SH "Detailed Description"
- .PP
- ESAPI function to invoke the TPM2_Clear command either as a one-call or in an asynchronous manner\&.
- .SH "Function Documentation"
- .PP
- .SS "TSS2_RC Esys_Clear_Async (\fBESYS_CONTEXT\fP * esysContext, \fBESYS_TR\fP authHandle, \fBESYS_TR\fP shandle1, \fBESYS_TR\fP shandle2, \fBESYS_TR\fP shandle3)"
- Asynchronous function for TPM2_Clear
- .PP
- This function invokes the TPM2_Clear command in a asynchronous variant\&. This means the function will return as soon as the command has been sent downwards the stack to the TPM\&. All input parameters are const\&. In order to retrieve the TPM's response call Esys_Clear_Finish\&.
- .PP
- \fBParameters:\fP
- .RS 4
- \fIesysContext\fP The \fBESYS_CONTEXT\fP\&.
- .br
- \fIauthHandle\fP TPM2_RH_LOCKOUT or TPM2_RH_PLATFORM+{PP}\&.
- .br
- \fIshandle1\fP Session handle for authorization of authHandle
- .br
- \fIshandle2\fP Second session handle\&.
- .br
- \fIshandle3\fP Third session handle\&.
- .RE
- .PP
- \fBReturn values:\fP
- .RS 4
- \fIESYS_RC_SUCCESS\fP if the function call was a success\&.
- .br
- \fITSS2_ESYS_RC_BAD_REFERENCE\fP if the esysContext or required input pointers or required output handle references are NULL\&.
- .br
- \fITSS2_ESYS_RC_BAD_CONTEXT\fP if esysContext corruption is detected\&.
- .br
- \fITSS2_ESYS_RC_MEMORY\fP if the ESAPI cannot allocate enough memory for internal operations or return parameters\&.
- .br
- \fITSS2_RCs\fP produced by lower layers of the software stack may be returned to the caller unaltered unless handled internally\&.
- .br
- \fITSS2_ESYS_RC_MULTIPLE_DECRYPT_SESSIONS\fP if more than one session has the 'decrypt' attribute bit set\&.
- .br
- \fITSS2_ESYS_RC_MULTIPLE_ENCRYPT_SESSIONS\fP if more than one session has the 'encrypt' attribute bit set\&.
- .br
- \fITSS2_ESYS_RC_BAD_TR\fP if any of the ESYS_TR objects are unknown to the \fBESYS_CONTEXT\fP or are of the wrong type or if required ESYS_TR objects are ESYS_TR_NONE\&.
- .br
- \fITSS2_ESYS_RC_NO_DECRYPT_PARAM\fP if one of the sessions has the 'decrypt' attribute set and the command does not support encryption of the first command parameter\&.
- .br
- \fITSS2_ESYS_RC_NO_ENCRYPT_PARAM\fP if one of the sessions has the 'encrypt' attribute set and the command does not support encryption of the first response parameter\&.
- .RE
- .PP
- .SH "Author"
- .PP
- Generated automatically by Doxygen for tpm2-tss from the source code\&.
|
