AIO_RETURN(3)              POSIX Programmer's Manual             AIO_RETURN(3)



PROLOG
       This manual page is part of the POSIX Programmer's Manual.  The OS
       implementation of this interface may differ (consult the corresponding
       OS manual page for details of OS behavior), or the interface may not be
       implemented on OS.

NAME
       aio_return -- retrieve return status of an asynchronous I/O operation

SYNOPSIS
       #include <aio.h>

       ssize_t aio_return(struct aiocb *aiocbp);

DESCRIPTION
       The aio__return() function shall return the return status associated
       with the aiocb structure referenced by the aiocbp argument. The return
       status for an asynchronous I/O operation is the value that would be
       returned by the corresponding read(), write(), or fsync() function
       call. If the error status for the operation is equal to [EINPROGRESS],
       then the return status for the operation is undefined. The aio__return()
       function may be called exactly once to retrieve the return status of a
       given asynchronous operation; thereafter, if the same aiocb structure
       is used in a call to aio__return() or aio__error(), an error may be
       returned. When the aiocb structure referred to by aiocbp is used to
       submit another asynchronous operation, then aio__return() may be
       successfully used to retrieve the return status of that operation.

RETURN VALUE
       If the asynchronous I/O operation has completed, then the return
       status, as described for read(), write(), and fsync(), shall be
       returned. If the asynchronous I/O operation has not yet completed, the
       results of aio__return() are undefined.

       If the aio__return() function fails, it shall return -1 and set errno to
       indicate the error.

ERRORS
       The aio__return() function may fail if:

       EINVAL The aiocbp argument does not refer to an asynchronous operation
              whose return status has not yet been retrieved.

       The following sections are informative.

EXAMPLES
       None.

APPLICATION USAGE
       None.

RATIONALE
       None.

FUTURE DIRECTIONS
       None.

SEE ALSO
       aio__cancel(), aio__error(), aio__fsync(), aio__read(), aio__write(),
       close(), exec, exit(), fork(), lio__listio(), lseek(), read()

       The Base Definitions volume of POSIX.1-2017, <aio.h>

COPYRIGHT
       Portions of this text are reprinted and reproduced in electronic form
       from IEEE Std 1003.1-2017, Standard for Information Technology --
       Portable Operating System Interface (POSIX), The Open Group Base
       Specifications Issue 7, 2018 Edition, Copyright (C) 2018 by the
       Institute of Electrical and Electronics Engineers, Inc and The Open
       Group.  In the event of any discrepancy between this version and the
       original IEEE and The Open Group Standard, the original IEEE and The
       Open Group Standard is the referee document. The original Standard can
       be obtained online at http://www.opengroup.org/unix/online.html .

       Any typographical or formatting errors that appear in this page are
       most likely to have been introduced during the conversion of the source
       files to man page format. To report such errors, see
       https://www.kernel.org/doc/man-pages/reporting_bugs.html .



IEEE/The Open Group                  2017                        AIO_RETURN(3)
