1 .\" Copyright (C) 2003 Free Software Foundation, Inc.
3 .\" %%%LICENSE_START(GPL_NOVERSION_ONELINE)
4 .\" This file is distributed according to the GNU General Public License.
7 .TH IO_CANCEL 2 2013-04-10 "Linux" "Linux Programmer's Manual"
9 io_cancel \- cancel an outstanding asynchronous I/O operation
12 .BR "#include <linux/aio_abi.h>" " /* Defines needed types */"
14 .BI "int io_cancel(aio_context_t " ctx_id ", struct iocb *" iocb ,
15 .BI " struct io_event *" result );
19 There is no glibc wrapper for this system call; see NOTES.
25 attempts to cancel an asynchronous I/O operation previously submitted with
29 argument describes the operation to be canceled and the
31 argument is the AIO context to which the operation was submitted.
32 If the operation is successfully canceled, the event will be copied into
33 the memory pointed to by
35 without being placed into the
41 For the failure return, see NOTES.
45 The \fIiocb\fP specified was not canceled.
48 One of the data structures points to invalid data.
51 The AIO context specified by \fIctx_id\fP is invalid.
55 is not implemented on this architecture.
58 The asynchronous I/O system calls first appeared in Linux 2.5.
62 is Linux-specific and should not be used
63 in programs that are intended to be portable.
65 Glibc does not provide a wrapper function for this system call.
66 You could invoke it using
68 But instead, you probably want to use the
70 wrapper function provided by
71 .\" http://git.fedorahosted.org/git/?p=libaio.git
76 wrapper function uses a different type
78 .\" But glibc is confused, since <libaio.h> uses 'io_context_t' to declare
85 wrapper does not follow the usual C library conventions for indicating errors:
86 on error it returns a negated error number
87 (the negative of one of the values listed in ERRORS).
88 If the system call is invoked via
90 then the return value follows the usual conventions for
91 indicating an error: \-1, with
93 set to a (positive) value that indicates the error.