AIO_RETURN(3P)

💖 AIO_RETURN 💖 (that's section 3P, bestie)

okay so real quick — this page is AIO_RETURN(3P) from the POSIX Programmer's Manual. Come sit with me, this one's short and sweet 🍓

---

🌸 PROLOG 🌸

so like, important disclaimer first: this manual page is part of the POSIX Programmer's Manual. The Linux implementation of this interface may differ — so if you're on Linux, go peek at the corresponding Linux manual page for the actual tea ☕. Also possible: the interface just isn't implemented on Linux at all. Not me being dramatic, that's literally what it says 💀

---

✨ NAME ✨

aio_return — retrieve return status of an asynchronous I/O operation

---

🎀 SYNOPSIS 🎀

#include <aio.h>

ssize_t aio_return(struct aiocb *aiocbp);

---

💅 DESCRIPTION 💅

okay so the aio_return() function shall return the return status associated with the aiocb structure referenced by the aiocbp argument. periodt.

The return status for an asynchronous I/O operation is the value that would be returned by the corresponding read(), write(), or fsync() function call. iconic behavior honestly.

🚨 now listen: if the error status for the operation is equal to [EINPROGRESS], then the return status for the operation is undefined. do not pass go.

The aio_return() function may be called exactly once to retrieve the return status of a given asynchronous operation. Like, one (1) time, bestie 🙈. After that, if the same aiocb structure is used in a call to aio_return() or aio_error(), an error may be returned. One shot, no re-dos.

BUT — plot twist ✨ — when the aiocb structure referred to by aiocbp is used to submit another asynchronous operation, then aio_return() may be successfully used to retrieve the return status of that operation. So it's not the struct that's burnt out, it's the operation. slay.

---

🔥 RETURN VALUE 🔥

If the asynchronous I/O operation has completed, then the return status, as described for read(), write(), and fsync(), shall be returned. 🫶

If the asynchronous I/O operation has not yet completed, the results of aio_return() are undefined. (translation: nobody knows, don't do it 😭)

If the aio_return() function fails, it shall return -1 and set errno to indicate the error.

---

💜 ERRORS 💜

The aio_return() function may fail if:

• EINVAL — the aiocbp argument does not refer to an asynchronous operation whose return status has not yet been retrieved.

---

🌈 heads up: the following sections are informative. (aka, they're vibes, not rules.)

---

🧚 EXAMPLES 🧚

None. literally nothing. empty. the void. 💀

---

🦋 APPLICATION USAGE 🦋

None. also empty bestie.

---

⭐ RATIONALE ⭐

None.

---

🌈 FUTURE DIRECTIONS 🌈

None.

---

👑 SEE ALSO 👑

• aio_cancel()
• aio_error()
• aio_fsync()
• aio_read()
• aio_write()
• close()
• exec
• exit()
• fork()
• lio_listio()
• lseek()
• read()

Also, from the Base Definitions volume of POSIX.1‐2017: <aio.h>

---

💖 COPYRIGHT 💖

Portions of this text are reprinted and reproduced in electronic form from IEEE Std 1003.1-2017, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 7, 2018 Edition, Copyright (C) 2018 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between this version and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html .

Any typographical or formatting errors that appear in this page are most likely to have been introduced during the conversion of the source files to man page format. To report such errors, see https://www.kernel.org/doc/man-pages/reporting_bugs.html .

---

and that's the whole page, bestie 🫶 brought to you by IEEE/The Open Group, dated 2017, filed under AIO_RETURN(3P) — stay async, stay iconic, mwah 💅✨