logo

oasis-root

Compiled tree of Oasis Linux based on own branch at <https://hacktivis.me/git/oasis/> git clone https://anongit.hacktivis.me/git/oasis-root.git

aio_error.3p (3232B)

    

  1. '\" et
  2. .TH AIO_ERROR "3P" 2017 "IEEE/The Open Group" "POSIX Programmer's Manual"
  3. .\"
  4. .SH PROLOG
  5. This manual page is part of the POSIX Programmer's Manual.
  6. The Linux implementation of this interface may differ (consult
  7. the corresponding Linux manual page for details of Linux behavior),
  8. or the interface may not be implemented on Linux.
  9. .\"
  10. .SH NAME
  11. aio_error
  12. \(em retrieve errors status for an asynchronous I/O operation
  13. .SH SYNOPSIS
  14. .LP
  15. .nf
  16. #include <aio.h>
  17. .P
  18. int aio_error(const struct aiocb *\fIaiocbp\fP);
  19. .fi
  20. .SH DESCRIPTION
  21. The
  22. \fIaio_error\fR()
  23. function shall return the error status associated with the
  24. .BR aiocb
  25. structure referenced by the
  26. .IR aiocbp
  27. argument. The error status for an asynchronous I/O operation is the
  28. .IR errno
  29. value that would be set by the corresponding
  30. \fIread\fR(),
  31. \fIwrite\fR(),
  32. \fIfdatasync\fR(),
  33. or
  34. \fIfsync\fR()
  35. operation. If the operation has not yet completed, then the error
  36. status shall be equal to
  37. .BR [EINPROGRESS] .
  38. .P
  39. If the
  40. .BR aiocb
  41. structure pointed to by
  42. .IR aiocbp
  43. is not associated with an operation that has been scheduled, the
  44. results are undefined.
  45. .SH "RETURN VALUE"
  46. If the asynchronous I/O operation has completed successfully, then 0
  47. shall be returned. If the asynchronous operation has completed
  48. unsuccessfully, then the error status, as described for
  49. \fIread\fR(),
  50. \fIwrite\fR(),
  51. \fIfdatasync\fR(),
  52. and
  53. \fIfsync\fR(),
  54. shall be returned. If the asynchronous I/O operation has not yet
  55. completed, then
  56. .BR [EINPROGRESS] 
  57. shall be returned.
  58. .P
  59. If the
  60. \fIaio_error\fR()
  61. function fails, it shall return \-1 and set
  62. .IR errno
  63. to indicate the error.
  64. .SH ERRORS
  65. The
  66. \fIaio_error\fR()
  67. function may fail if:
  68. .TP
  69. .BR EINVAL
  70. The
  71. .IR aiocbp
  72. argument does not refer to an asynchronous operation whose return
  73. status has not yet been retrieved.
  74. .LP
  75. .IR "The following sections are informative."
  76. .SH EXAMPLES
  77. None.
  78. .SH "APPLICATION USAGE"
  79. None.
  80. .SH RATIONALE
  81. None.
  82. .SH "FUTURE DIRECTIONS"
  83. None.
  84. .SH "SEE ALSO"
  85. .ad l
  86. .IR "\fIaio_cancel\fR\^(\|)",
  87. .IR "\fIaio_fsync\fR\^(\|)",
  88. .IR "\fIaio_read\fR\^(\|)",
  89. .IR "\fIaio_return\fR\^(\|)",
  90. .IR "\fIaio_write\fR\^(\|)",
  91. .IR "\fIclose\fR\^(\|)",
  92. .IR "\fIexec\fR\^",
  93. .IR "\fIexit\fR\^(\|)",
  94. .IR "\fIfork\fR\^(\|)",
  95. .IR "\fIlio_listio\fR\^(\|)",
  96. .IR "\fIlseek\fR\^(\|)",
  97. .IR "\fIread\fR\^(\|)"
  98. .ad b
  99. .P
  100. The Base Definitions volume of POSIX.1\(hy2017,
  101. .IR "\fB<aio.h>\fP"
  102. .\"
  103. .SH COPYRIGHT
  104. Portions of this text are reprinted and reproduced in electronic form
  105. from IEEE Std 1003.1-2017, Standard for Information Technology
  106. -- Portable Operating System Interface (POSIX), The Open Group Base
  107. Specifications Issue 7, 2018 Edition,
  108. Copyright (C) 2018 by the Institute of
  109. Electrical and Electronics Engineers, Inc and The Open Group.
  110. In the event of any discrepancy between this version and the original IEEE and
  111. The Open Group Standard, the original IEEE and The Open Group Standard
  112. is the referee document. The original Standard can be obtained online at
  113. http://www.opengroup.org/unix/online.html .
  114. .PP
  115. Any typographical or formatting errors that appear
  116. in this page are most likely
  117. to have been introduced during the conversion of the source files to
  118. man page format. To report such errors, see
  119. https://www.kernel.org/doc/man-pages/reporting_bugs.html .