]> git.ipfire.org Git - thirdparty/man-pages.git/blame - man3/aio_error.3
Wrapped long lines, wrapped at sentence boundaries; stripped trailing
[thirdparty/man-pages.git] / man3 / aio_error.3
CommitLineData
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.\"
23.TH AIO_ERROR 3 2003-11-14 "" "Linux Programmer's Manual"
24.SH NAME
25aio_error \- get error status of asynchronous I/O operation
26.SH SYNOPSIS
27.sp
28.B "#include <aio.h>"
29.sp
30.BI "int aio_error(const struct aiocb *" aiocbp );
fea681da
MK
31.SH DESCRIPTION
32The
e511ffb6 33.BR aio_error ()
fea681da
MK
34function returns the error status for the asynchronous I/O request
35with control block pointed to by
36.IR aiocbp .
37.SH "RETURN VALUE"
38This function returns EINPROGRESS if the request has not been
c13182ef
MK
39completed yet.
40It returns ECANCELED if the request was cancelled.
fea681da
MK
41It returns 0 if the request completed successfully.
42Otherwise an error value is returned, the same value that would have
43been stored in the
44.I errno
45variable in case of a synchronous
46.IR read ,
47.IR write ,
48.IR fsync ,
49or
50.I fdatasync
51request.
52On error, the error value is returned.
53.SH ERRORS
54.TP
55.B EINVAL
56.I aiocbp
57does not point at a control block for an asynchronous I/O request
58of which the return status (see
59.BR aio_return (3))
60has not been retrieved yet.
61.SH "CONFORMING TO"
68e1685c 62POSIX.1-2001
fea681da
MK
63.SH "SEE ALSO"
64.BR aio_cancel (3),
65.BR aio_fsync (3),
66.BR aio_read (3),
67.BR aio_return (3),
68.BR aio_suspend (3),
69.BR aio_write (3)