man2/io_cancel.2

   1 .\" Copyright (C) 2003 Free Software Foundation, Inc.
   2 .\" This file is distributed according to the GNU General Public License.
   3 .\" See the file COPYING in the top level source directory for details.
   4 .\"
   5 .\" .de Sh \" Subsection
   6 .\" .br
   7 .\" .if t .Sp
   8 .\" .ne 5
   9 .\" .PP
  10 .\" \fB\\$1\fR
  11 .\" .PP
  12 .\" ..
  13 .\" .de Sp \" Vertical space (when we can't use .PP)
  14 .\" .if t .sp .5v
  15 .\" .if n .sp
  16 .\" ..
  17 .\" .de Ip \" List item
  18 .\" .br
  19 .\" .ie \\n(.$>=3 .ne \\$3
  20 .\" .el .ne 3
  21 .\" .IP "\\$1" \\$2
  22 .\" ..
  23 .TH IO_CANCEL 2 2003-02-21 "Linux 2.4" "Linux Programmer's Manual"
  24 .SH NAME
  25 io_cancel \- cancel an outstanding asynchronous I/O operation
  26 .SH "SYNOPSIS"
  27 .nf
  28 .\" .ad l
  29 .\" .hy 0
  30 .\"
  31 .B #include <libaio.h>
  32 .\"#include <linux/aio.h>
  33 .sp
  34 .\" .HP 16
  35 .BI "int io_cancel(aio_context_t " ctx_id ", struct iocb *" iocb ,
  36 .BI "              struct io_event *" result );
  37 .\" .ad
  38 .\" .hy
  39 .fi
  40 .SH "DESCRIPTION"
  41 .PP
  42 .BR io_cancel ()
  43 attempts to cancel an asynchronous I/O operation previously submitted with
  44 .BR io_submit (2).
  45 \fIctx_id\fR is the AIO context ID of the operation to be cancelled.
  46 If the AIO context is found, the event will be cancelled and then copied
  47 into the memory pointed to by \fIresult\fR without being placed
  48 into the completion queue.
  49 .SH "RETURN VALUE"
  50 .PP
  51 .BR io_cancel ()
  52 returns 0 on success;
  53 on failure, it returns one of the errors listed under ERRORS.
  54 .SH "ERRORS"
  55 .TP
  56 .B EINVAL
  57 The AIO context specified by \fIctx_id\fR is invalid.
  58 .TP
  59 .B EFAULT
  60 One of the data structures points to invalid data.
  61 .TP
  62 .B EAGAIN
  63 The \fIiocb\fR specified was not cancelled.
  64 .TP
  65 .B ENOSYS
  66 .BR io_cancel ()
  67 is not implemented on this architecture.
  68 .SH "VERSIONS"
  69 .PP
  70 The asynchronous I/O system calls first appeared in Linux 2.5, August 2002.
  71 .SH "CONFORMING TO"
  72 .PP
  73 .BR io_cancel ()
  74 is Linux specific and should not be used
  75 in programs that are intended to be portable.
  76 .SH "SEE ALSO"
  77 .PP
  78 .BR io_setup (2),
  79 .BR io_destroy (2),
  80 .BR io_getevents (2),
  81 .BR io_submit (2)
  82 .\" .SH "NOTES"
  83 .\"
  84 .\" .PP
  85 .\" The asynchronous I/O system calls were written by Benjamin LaHaise.
  86 .\"
  87 .\" .SH AUTHOR
  88 .\" Kent Yoder.