release/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\fP
  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 .\"*******************************************************************
  24 .\"
  25 .\" This file was generated with po4a. Translate the source file.
  26 .\"
  27 .\"*******************************************************************
  28 .TH IO_CANCEL 2 2008\-06\-18 Linux "Linux Programmer's Manual"
  29 .SH 名前
  30 io_cancel \- 未処理の非同期 I/O 操作の取り消し
  31 .SH 書式
  32 .nf
  33 .\" .ad l
  34 .\" .hy 0
  35 .\"
  36 .\"#include <linux/aio.h>
  37 \fB#include <libaio.h>\fP
  38 .sp
  39 .\" .HP 16
  40 .\" .ad
  41 .\" .hy
  42 \fBint io_cancel(aio_context_t \fP\fIctx_id\fP\fB, struct iocb *\fP\fIiocb\fP\fB,\fP
  43 \fB              struct io_event *\fP\fIresult\fP\fB);\fP
  44 .sp
  45 \fI\-laio\fP とリンクする。
  46 .fi
  47 .SH 説明
  48 .PP
  49 \fBio_cancel\fP()  は、過去に \fBio_submit\fP(2)  を使って登録された非同期 I/O (AIO)
  50 操作の取り消しを行おうとする。 \fIctx_id\fP は、取り消しを行う操作の AIO コンテキストの ID である。 指定した AIO
  51 コンテキストが見つかると、 対象のイベントの取り消しが行われ、その後 \fIresult\fP で指されたメモリに コピーされる
  52 (このとき、完了キューへの移動は行われない)。
  53 .SH 返り値
  54 成功した場合、 \fBio_cancel\fP()  は 0 を返す。 失敗時の返り値については、「注意」の節を参照すること。
  55 .SH エラー
  56 .TP
  57 \fBEAGAIN\fP
  58 指定された \fIiocb\fP の取り消しが行われなかった。
  59 .TP
  60 \fBEFAULT\fP
  61 データ構造の中に無効なデータを指しているものがある。
  62 .TP
  63 \fBEINVAL\fP
  64 \fIctx_id\fP で指定された AIO コンテキストが無効である。
  65 .TP
  66 \fBENOSYS\fP
  67 \fBio_cancel\fP()  はこのアーキテクチャでは実装されていない。
  68 .SH バージョン
  69 .PP
  70 非同期 I/O システム・コールは 2002年8月に Linux 2.5 で初めて登場した。
  71 .SH 準拠
  72 .PP
  73 \fBio_cancel\fP()  は Linux 固有であり、移植を想定したプログラムで使用すべきではない。
  74 .SH 注意
  75 glibc はこのシステムコール用のラッパー関数を提供していない。
  76
  77 \fIlibaio\fP で \fBio_cancel\fP()  用に提供されているラッパー関数は、エラーの通知が通常の C ライブラリの
  78 慣習にしたがっておらず、エラーの場合には負のエラー番号 (エラーの節に列挙されている値の一つを負にしたもの) が返り値となる。
  79 \fBsyscall\fP(2)  経由でシステムコールを起動すると、返り値は通常のエラー通知の慣習に したがってものとなり、エラーの場合には \-1 が返り、
  80 \fIerrno\fP にエラーを示す (正の) 値が設定される。
  81 .SH 関連項目
  82 \fBio_destroy\fP(2), \fBio_getevents\fP(2), \fBio_setup\fP(2), \fBio_submit\fP(2),
  83 \fBaio\fP(7)
  84 .\" .SH "NOTES"
  85 .\"
  86 .\" .PP
  87 .\" The asynchronous I/O system calls were written by Benjamin LaHaise.
  88 .\"
  89 .\" .SH AUTHOR
  90 .\" Kent Yoder.