]> git.ipfire.org Git - thirdparty/man-pages.git/blobdiff - man3/aio_return.3
Removed trailing white space at end of lines
[thirdparty/man-pages.git] / man3 / aio_return.3
index a89c7bc700fd8f353c77694bd80f74cdce1e07e4..237e569e814c26e0991013eae98b817b13020337 100644 (file)
@@ -1,5 +1,6 @@
 .\" Copyright (c) 2003 Andries Brouwer (aeb@cwi.nl)
 .\"
+.\" %%%LICENSE_START(GPLv2+_DOC_FULL)
 .\" This is free documentation; you can redistribute it and/or
 .\" modify it under the terms of the GNU General Public License as
 .\" published by the Free Software Foundation; either version 2 of
 .\" GNU General Public License for more details.
 .\"
 .\" You should have received a copy of the GNU General Public
-.\" License along with this manual; if not, write to the Free
-.\" Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111,
-.\" USA.
+.\" License along with this manual; if not, see
+.\" <http://www.gnu.org/licenses/>.
+.\" %%%LICENSE_END
 .\"
-.TH AIO_RETURN 3 2010-10-02  "" "Linux Programmer's Manual"
+.TH AIO_RETURN 3 2017-09-15  "" "Linux Programmer's Manual"
 .SH NAME
 aio_return \- get return status of asynchronous I/O operation
 .SH SYNOPSIS
 .B "#include <aio.h>"
-.sp
+.PP
 .BI "ssize_t aio_return(struct aiocb *" aiocbp );
-.sp
+.PP
 Link with \fI\-lrt\fP.
 .SH DESCRIPTION
 The
@@ -35,38 +36,68 @@ The
 function returns the final return status for the asynchronous I/O request
 with control block pointed to by
 .IR aiocbp .
-.LP
+(See
+.BR aio (7)
+for a description of the
+.I aiocb
+structure.)
+.PP
 This function should be called only once for any given request, after
 .BR aio_error (3)
 returns something other than
 .BR EINPROGRESS .
-.SH "RETURN VALUE"
+.SH RETURN VALUE
 If the asynchronous I/O operation has completed, this function returns
 the value that would have been returned in case of a synchronous
-.IR read ,
-.IR write ,
+.BR read (2),
+.BR write (2),
+.BR fsync (2)
 or
-.I fsync
-request.
-Otherwise the return value is undefined.
-On error, the error value is returned.
+.BR fdatasync (2),
+call.
+On error, \-1 is returned, and \fIerrno\fP is set appropriately.
+.PP
+If the asynchronous I/O operation has not yet completed,
+the return value and effect of
+.BR aio_return ()
+are undefined.
 .SH ERRORS
 .TP
 .B EINVAL
 .I aiocbp
 does not point at a control block for an asynchronous I/O request
 of which the return status has not been retrieved yet.
+.TP
+.B ENOSYS
+.BR aio_return ()
+is not implemented.
 .SH VERSIONS
 The
 .BR aio_return ()
 function is available since glibc 2.1.
-.SH "CONFORMING TO"
+.SH ATTRIBUTES
+For an explanation of the terms used in this section, see
+.BR attributes (7).
+.TS
+allbox;
+lb lb lb
+l l l.
+Interface      Attribute       Value
+T{
+.BR aio_return ()
+T}     Thread safety   MT-Safe
+.TE
+.SH CONFORMING TO
 POSIX.1-2001, POSIX.1-2008.
-.SH "SEE ALSO"
+.SH EXAMPLE
+See
+.BR aio (7).
+.SH SEE ALSO
 .BR aio_cancel (3),
 .BR aio_error (3),
 .BR aio_fsync (3),
 .BR aio_read (3),
 .BR aio_suspend (3),
 .BR aio_write (3),
+.BR lio_listio (3),
 .BR aio (7)