csu3_am335x/EVSE/GPL/tpm2-tss-3.2.0/doxygen-doc/man/Fapi_GetPollHandles.3

.TH "Fapi_GetPollHandles" 3 "Fri Oct 7 2022" "Version 3.2.0" "tpm2-tss" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Fapi_GetPollHandles
.SH SYNOPSIS
.br
.PP
.SS "Functions"

.in +1c
.ti -1c
.RI "TSS2_RC \fBFapi_GetPollHandles\fP (\fBFAPI_CONTEXT\fP *context, FAPI_POLL_HANDLE **handles, size_t *num_handles)"
.br
.in -1c
.SH "Detailed Description"
.PP 
FAPI function to retrieve the poll handles currently used by the corresponding \fBFAPI_CONTEXT\fP\&. 
.SH "Function Documentation"
.PP 
.SS "Fapi_GetPollHandles (\fBFAPI_CONTEXT\fP * context, FAPI_POLL_HANDLE ** handles, size_t * num_handles)"
Retrieve handles for polling
.PP
Returns an array of handles that can be polled on to get notified when data from the TPM or from a disk operation is available\&.
.PP
The corresponding code should look similar to follows: do { r = Fapi_GetPollHandles(fc, &ph, &nph); if (r == TSS2_RC_SUCCESS) { poll(ph, nph, -1); Fapi_Free(ph); } r = Fapi_*_Finish(fc, \&.\&.\&.); } while (r == TSS2_FAPI_RC_TRY_AGAIN);
.PP
\fBParameters:\fP
.RS 4
\fIcontext\fP The \fBFAPI_CONTEXT\fP 
.br
\fIhandles\fP An array of poll handle entries 
.br
\fInum_handles\fP The size of the array in handles
.RE
.PP
\fBReturn values:\fP
.RS 4
\fITSS2_RC_SUCCESS\fP if the function call was a success\&. 
.br
\fITSS2_FAPI_RC_BAD_REFERENCE\fP if context or data is NULL\&. 
.br
\fITSS2_FAPI_RC_BAD_CONTEXT\fP if context corruption is detected\&. 
.br
\fITSS2_FAPI_RC_BAD_SEQUENCE\fP if the context has no asynchronous operation pending\&. 
.br
\fITSS2_FAPI_RC_NO_HANDLE\fP if there are no handles to poll on 
.br
\fITSS2_FAPI_RC_MEMORY\fP if the FAPI cannot allocate enough memory for internal operations or return parameters\&. 
.RE
.PP

.SH "Author"
.PP 
Generated automatically by Doxygen for tpm2-tss from the source code\&.