projects / thirdparty / man-pages.git / blame
| Commit | Line | Data |
|---|---|---|
| fea681da MK |
1 | .\" Copyright (c) 2003 Andries Brouwer (aeb@cwi.nl) |
| 2 | .\" | |
| 3 | .\" This is free documentation; you can redistribute it and/or | |
| 4 | .\" modify it under the terms of the GNU General Public License as | |
| 5 | .\" published by the Free Software Foundation; either version 2 of | |
| 6 | .\" the License, or (at your option) any later version. | |
| 7 | .\" | |
| 8 | .\" The GNU General Public License's references to "object code" | |
| 9 | .\" and "executables" are to be interpreted as the output of any | |
| 10 | .\" document formatting or typesetting system, including | |
| 11 | .\" intermediate and printed output. | |
| 12 | .\" | |
| 13 | .\" This manual is distributed in the hope that it will be useful, | |
| 14 | .\" but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 15 | .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
| 16 | .\" GNU General Public License for more details. | |
| 17 | .\" | |
| 18 | .\" You should have received a copy of the GNU General Public | |
| 19 | .\" License along with this manual; if not, write to the Free | |
| 20 | .\" Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, | |
| 21 | .\" USA. | |
| 22 | .\" | |
| 25fa6c3d | 23 | .TH AIO_RETURN 3 2010-10-02 "" "Linux Programmer's Manual" |
| fea681da MK |
24 | .SH NAME |
| 25 | aio_return \- get return status of asynchronous I/O operation | |
| 26 | .SH SYNOPSIS | |
| fea681da MK |
27 | .B "#include <aio.h>" |
| 28 | .sp | |
| 29 | .BI "ssize_t aio_return(struct aiocb *" aiocbp ); | |
| 0ad25472 MK |
30 | .sp |
| 31 | Link with \fI\-lrt\fP. | |
| fea681da MK |
32 | .SH DESCRIPTION |
| 33 | The | |
| e511ffb6 | 34 | .BR aio_return () |
| fea681da MK |
35 | function returns the final return status for the asynchronous I/O request |
| 36 | with control block pointed to by | |
| 37 | .IR aiocbp . | |
| 38 | .LP | |
| 39 | This function should be called only once for any given request, after | |
| a2ef1094 | 40 | .BR aio_error (3) |
| 2f0af33b MK |
41 | returns something other than |
| 42 | .BR EINPROGRESS . | |
| fea681da MK |
43 | .SH "RETURN VALUE" |
| 44 | If the asynchronous I/O operation has completed, this function returns | |
| 45 | the value that would have been returned in case of a synchronous | |
| 46 | .IR read , | |
| 47 | .IR write , | |
| 48 | or | |
| 0daa9e92 | 49 | .I fsync |
| fea681da MK |
50 | request. |
| 51 | Otherwise the return value is undefined. | |
| 52 | On error, the error value is returned. | |
| 53 | .SH ERRORS | |
| 54 | .TP | |
| 55 | .B EINVAL | |
| 56 | .I aiocbp | |
| 57 | does not point at a control block for an asynchronous I/O request | |
| 58 | of which the return status has not been retrieved yet. | |
| 793514ae MK |
59 | .SH VERSIONS |
| 60 | The | |
| 61 | .BR aio_return () | |
| 62 | function is available since glibc 2.1. | |
| fea681da | 63 | .SH "CONFORMING TO" |
| 793514ae | 64 | POSIX.1-2001, POSIX.1-2008. |
| fea681da MK |
65 | .SH "SEE ALSO" |
| 66 | .BR aio_cancel (3), | |
| 67 | .BR aio_error (3), | |
| 68 | .BR aio_fsync (3), | |
| 69 | .BR aio_read (3), | |
| 70 | .BR aio_suspend (3), | |
| 25fa6c3d MK |
71 | .BR aio_write (3), |
| 72 | .BR aio (7) |