man-pages/man3/aio_return.3.html
2021-03-31 01:06:50 +01:00

177 lines
4.3 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of AIO_RETURN</TITLE>
</HEAD><BODY>
<H1>AIO_RETURN</H1>
Section: Linux Programmer's Manual (3)<BR>Updated: 2017-09-15<BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
aio_return - get return status of asynchronous I/O operation
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<B>#include &lt;<A HREF="file:///usr/include/aio.h">aio.h</A>&gt;</B>
<P>
<B>ssize_t aio_return(struct aiocb *</B><I>aiocbp</I><B>);</B>
<P>
Link with <I>-lrt</I>.
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
The
<B>aio_return</B>()
function returns the final return status for the asynchronous I/O request
with control block pointed to by
<I>aiocbp</I>.
(See
<B><A HREF="/cgi-bin/man/man2html?7+aio">aio</A></B>(7)
for a description of the
<I>aiocb</I>
structure.)
<P>
This function should be called only once for any given request, after
<B><A HREF="/cgi-bin/man/man2html?3+aio_error">aio_error</A></B>(3)
returns something other than
<B>EINPROGRESS</B>.
<A NAME="lbAE">&nbsp;</A>
<H2>RETURN VALUE</H2>
If the asynchronous I/O operation has completed, this function returns
the value that would have been returned in case of a synchronous
<B><A HREF="/cgi-bin/man/man2html?2+read">read</A></B>(2),
<B><A HREF="/cgi-bin/man/man2html?2+write">write</A></B>(2),
<B><A HREF="/cgi-bin/man/man2html?2+fsync">fsync</A></B>(2)
or
<B><A HREF="/cgi-bin/man/man2html?2+fdatasync">fdatasync</A></B>(2),
call.
On error, -1 is returned, and <I>errno</I> is set appropriately.
<P>
If the asynchronous I/O operation has not yet completed,
the return value and effect of
<B>aio_return</B>()
are undefined.
<A NAME="lbAF">&nbsp;</A>
<H2>ERRORS</H2>
<DL COMPACT>
<DT id="1"><B>EINVAL</B>
<DD>
<I>aiocbp</I>
does not point at a control block for an asynchronous I/O request
of which the return status has not been retrieved yet.
<DT id="2"><B>ENOSYS</B>
<DD>
<B>aio_return</B>()
is not implemented.
</DL>
<A NAME="lbAG">&nbsp;</A>
<H2>VERSIONS</H2>
The
<B>aio_return</B>()
function is available since glibc 2.1.
<A NAME="lbAH">&nbsp;</A>
<H2>ATTRIBUTES</H2>
For an explanation of the terms used in this section, see
<B><A HREF="/cgi-bin/man/man2html?7+attributes">attributes</A></B>(7).
<TABLE BORDER>
<TR VALIGN=top><TD><B>Interface</B></TD><TD><B>Attribute</B></TD><TD><B>Value</B><BR></TD></TR>
<TR VALIGN=top><TD>
<B>aio_return</B>()
</TD><TD>Thread safety</TD><TD>MT-Safe<BR></TD></TR>
</TABLE>
<A NAME="lbAI">&nbsp;</A>
<H2>CONFORMING TO</H2>
POSIX.1-2001, POSIX.1-2008.
<A NAME="lbAJ">&nbsp;</A>
<H2>EXAMPLE</H2>
See
<B><A HREF="/cgi-bin/man/man2html?7+aio">aio</A></B>(7).
<A NAME="lbAK">&nbsp;</A>
<H2>SEE ALSO</H2>
<B><A HREF="/cgi-bin/man/man2html?3+aio_cancel">aio_cancel</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+aio_error">aio_error</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+aio_fsync">aio_fsync</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+aio_read">aio_read</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+aio_suspend">aio_suspend</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+aio_write">aio_write</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+lio_listio">lio_listio</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?7+aio">aio</A></B>(7)
<A NAME="lbAL">&nbsp;</A>
<H2>COLOPHON</H2>
This page is part of release 5.05 of the Linux
<I>man-pages</I>
project.
A description of the project,
information about reporting bugs,
and the latest version of this page,
can be found at
<A HREF="https://www.kernel.org/doc/man-pages/.">https://www.kernel.org/doc/man-pages/.</A>
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="3"><A HREF="#lbAB">NAME</A><DD>
<DT id="4"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="5"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT id="6"><A HREF="#lbAE">RETURN VALUE</A><DD>
<DT id="7"><A HREF="#lbAF">ERRORS</A><DD>
<DT id="8"><A HREF="#lbAG">VERSIONS</A><DD>
<DT id="9"><A HREF="#lbAH">ATTRIBUTES</A><DD>
<DT id="10"><A HREF="#lbAI">CONFORMING TO</A><DD>
<DT id="11"><A HREF="#lbAJ">EXAMPLE</A><DD>
<DT id="12"><A HREF="#lbAK">SEE ALSO</A><DD>
<DT id="13"><A HREF="#lbAL">COLOPHON</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:05:35 GMT, March 31, 2021
</BODY>
</HTML>