man3/aio_error.3

   1 .\" Copyright (c) 2003 Andries Brouwer (aeb@cwi.nl)
   2 .\"
   3 .\" SPDX-License-Identifier: GPL-2.0-or-later
   4 .\"
   5 .TH AIO_ERROR 3 2021-03-22 GNU "Linux Programmer's Manual"
   6 .SH NAME
   7 aio_error \- get error status of asynchronous I/O operation
   8 .SH LIBRARY
   9 Real-time library
  10 .RI ( librt ", " \-lrt )
  11 .SH SYNOPSIS
  12 .nf
  13 .B "#include <aio.h>"
  14 .PP
  15 .BI "int aio_error(const struct aiocb *" aiocbp );
  16 .fi
  17 .SH DESCRIPTION
  18 The
  19 .BR aio_error ()
  20 function returns the error status for the asynchronous I/O request
  21 with control block pointed to by
  22 .IR aiocbp .
  23 (See
  24 .BR aio (7)
  25 for a description of the
  26 .I aiocb
  27 structure.)
  28 .SH RETURN VALUE
  29 This function returns one of the following:
  30 .IP * 3
  31 .BR EINPROGRESS ,
  32 if the request has not been
  33 completed yet.
  34 .IP *
  35 .BR ECANCELED ,
  36 if the request was canceled.
  37 .IP *
  38 0, if the request completed successfully.
  39 .IP *
  40 A positive error number, if the asynchronous I/O operation failed.
  41 This is the same value that would have been stored in the
  42 .I errno
  43 variable in the case of a synchronous
  44 .BR read (2),
  45 .BR write (2),
  46 .BR fsync (2),
  47 or
  48 .BR fdatasync (2)
  49 call.
  50 .SH ERRORS
  51 .TP
  52 .B EINVAL
  53 .I aiocbp
  54 does not point at a control block for an asynchronous I/O request
  55 of which the return status (see
  56 .BR aio_return (3))
  57 has not been retrieved yet.
  58 .TP
  59 .B ENOSYS
  60 .BR aio_error ()
  61 is not implemented.
  62 .SH VERSIONS
  63 The
  64 .BR aio_error ()
  65 function is available since glibc 2.1.
  66 .SH ATTRIBUTES
  67 For an explanation of the terms used in this section, see
  68 .BR attributes (7).
  69 .ad l
  70 .nh
  71 .TS
  72 allbox;
  73 lbx lb lb
  74 l l l.
  75 Interface       Attribute       Value
  76 T{
  77 .BR aio_error ()
  78 T}      Thread safety   MT-Safe
  79 .TE
  80 .hy
  81 .ad
  82 .sp 1
  83 .SH CONFORMING TO
  84 POSIX.1-2001, POSIX.1-2008.
  85 .SH EXAMPLES
  86 See
  87 .BR aio (7).
  88 .SH SEE ALSO
  89 .BR aio_cancel (3),
  90 .BR aio_fsync (3),
  91 .BR aio_read (3),
  92 .BR aio_return (3),
  93 .BR aio_suspend (3),
  94 .BR aio_write (3),
  95 .BR lio_listio (3),
  96 .BR aio (7)