|
1
by Francesco Paolo Lovergine
rules: linking manpages-posix not manpages. |
1 |
.\" Copyright (c) 2001-2003 The Open Group, All Rights Reserved |
|
2
by Francesco Paolo Lovergine
* Alligned to linux main manpages edition. |
2 |
.TH "AIO_ERROR" P 2003 "IEEE/The Open Group" "POSIX Programmer's Manual" |
|
1
by Francesco Paolo Lovergine
rules: linking manpages-posix not manpages. |
3 |
.\" aio_error |
4 |
.SH NAME |
|
5 |
aio_error \- retrieve errors status for an asynchronous I/O operation
|
|
6 |
(\fBREALTIME\fP) |
|
7 |
.SH SYNOPSIS |
|
8 |
.LP
|
|
9 |
\fB#include <aio.h>
|
|
10 |
.br
|
|
11 |
.sp
|
|
12 |
int aio_error(const struct aiocb *\fP\fIaiocbp\fP\fB); \fP |
|
13 |
\fB
|
|
14 |
.br
|
|
15 |
\fP
|
|
16 |
.SH DESCRIPTION |
|
17 |
.LP
|
|
18 |
The \fIaio_error\fP() function shall return the error status associated |
|
19 |
with the \fBaiocb\fP structure referenced by the |
|
20 |
\fIaiocbp\fP argument. The error status for an asynchronous I/O operation |
|
21 |
is the \fIerrno\fP value that would be set by the |
|
22 |
corresponding \fIread\fP(), \fIwrite\fP(), \fIfdatasync\fP(), or |
|
23 |
\fIfsync\fP() operation. If the operation has not yet completed, then |
|
24 |
the error status shall be |
|
25 |
equal to [EINPROGRESS]. |
|
26 |
.SH RETURN VALUE |
|
27 |
.LP
|
|
28 |
If the asynchronous I/O operation has completed successfully, then |
|
29 |
0 shall be returned. If the asynchronous operation has |
|
30 |
completed unsuccessfully, then the error status, as described for |
|
31 |
\fIread\fP(), \fIwrite\fP(), \fIfdatasync\fP(), and \fIfsync\fP(), |
|
32 |
shall be returned. |
|
33 |
If the asynchronous I/O operation has not yet completed, then [EINPROGRESS] |
|
34 |
shall be returned. |
|
35 |
.SH ERRORS |
|
36 |
.LP
|
|
37 |
The \fIaio_error\fP() function may fail if: |
|
38 |
.TP 7 |
|
39 |
.B EINVAL |
|
40 |
The \fIaiocbp\fP argument does not refer to an asynchronous operation |
|
41 |
whose return status has not yet been retrieved. |
|
42 |
.sp
|
|
43 |
.LP
|
|
44 |
\fIThe following sections are informative.\fP |
|
45 |
.SH EXAMPLES |
|
46 |
.LP
|
|
47 |
None. |
|
48 |
.SH APPLICATION USAGE |
|
49 |
.LP
|
|
50 |
The \fIaio_error\fP() function is part of the Asynchronous Input and |
|
51 |
Output option and need not be available on all |
|
52 |
implementations. |
|
53 |
.SH RATIONALE |
|
54 |
.LP
|
|
55 |
None. |
|
56 |
.SH FUTURE DIRECTIONS |
|
57 |
.LP
|
|
58 |
None. |
|
59 |
.SH SEE ALSO |
|
60 |
.LP
|
|
61 |
\fIaio_cancel\fP() , \fIaio_fsync\fP() , \fIaio_read\fP() , \fIaio_return\fP() |
|
62 |
, \fIaio_write\fP() , \fIclose\fP() , \fIexec\fP() , \fIexit\fP() |
|
63 |
, \fIfork\fP() , \fIlio_listio\fP() , \fIlseek\fP() , \fIread\fP() |
|
64 |
, |
|
65 |
the Base Definitions volume of IEEE\ Std\ 1003.1-2001, \fI<aio.h>\fP |
|
66 |
.SH COPYRIGHT |
|
67 |
Portions of this text are reprinted and reproduced in electronic form |
|
68 |
from IEEE Std 1003.1, 2003 Edition, Standard for Information Technology |
|
69 |
-- Portable Operating System Interface (POSIX), The Open Group Base |
|
70 |
Specifications Issue 6, Copyright (C) 2001-2003 by the Institute of |
|
71 |
Electrical and Electronics Engineers, Inc and The Open Group. In the |
|
72 |
event of any discrepancy between this version and the original IEEE and |
|
73 |
The Open Group Standard, the original IEEE and The Open Group Standard |
|
74 |
is the referee document. The original Standard can be obtained online at |
|
75 |
http://www.opengroup.org/unix/online.html . |