aio_cancel.3: Rewrite RETURN VALUE section to be clearer

Reported-by: Jon Grant <jg@jguk.org>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
This commit is contained in:
Michael Kerrisk 2012-04-18 08:15:11 +12:00
parent 53fdc589c6
commit fb07934b18
1 changed files with 16 additions and 13 deletions

View File

@ -20,7 +20,7 @@
.\" Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111,
.\" USA.
.\"
.TH AIO_CANCEL 3 2011-10-04 "" "Linux Programmer's Manual"
.TH AIO_CANCEL 3 2012-04-18 "" "Linux Programmer's Manual"
.SH NAME
aio_cancel \- cancel an outstanding asynchronous I/O request
.SH SYNOPSIS
@ -67,23 +67,26 @@ was initiated, unspecified results occur.
Which operations are cancelable is implementation-defined.
.\" FreeBSD: not those on raw disk devices.
.SH "RETURN VALUE"
This function returns
The
.BR aio_cancel ()
function returns one of the following values:
.TP
.B AIO_CANCELED
if all requests were successfully
canceled.
It returns
All requests were successfully canceled.
.TP
.B AIO_NOTCANCELED
when at least one of the
At least one of the
requests specified was not canceled because it was in progress.
In this case one may check the status of individual requests using
In this case, one may check the status of individual requests using
.BR aio_error (3).
This function returns
.TP
.B AIO_ALLDONE
if all requests had
already been completed before this call.
When some error occurs, \-1 is returned, and
.I errno
is set appropriately.
All requests had already been completed before the call.
.TP
\-1
An error occurred.
The cause of the error can be found by inspecting
.IR errno .
.SH ERRORS
.TP
.B EBADF