io_cancel.2: Improve description

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
This commit is contained in:
Jeff Moyer 2013-04-10 22:49:00 +02:00 committed by Michael Kerrisk
parent 1d79f88e2e
commit 9f621816bc
1 changed files with 7 additions and 5 deletions

View File

@ -4,7 +4,7 @@
.\" This file is distributed according to the GNU General Public License.
.\" %%%LICENSE_END
.\"
.TH IO_CANCEL 2 2012-07-13 "Linux" "Linux Programmer's Manual"
.TH IO_CANCEL 2 2013-04-10 "Linux" "Linux Programmer's Manual"
.SH NAME
io_cancel \- cancel an outstanding asynchronous I/O operation
.SH SYNOPSIS
@ -26,10 +26,12 @@ attempts to cancel an asynchronous I/O operation previously submitted with
.BR io_submit (2).
The
.I ctx_id
argument is the AIO context ID of the operation to be canceled.
If the AIO context is found, the event will be canceled and then copied
into the memory pointed to by \fIresult\fP without being placed
into the completion queue.
argument is the AIO context ID into which the operation was submitted.
If the operation is successfully canceled, the event will be copied into
the memory pointed to by
.I result
without being placed into the
completion queue.
.SH RETURN VALUE
On success,
.BR io_cancel ()