release/man2/io_cancel.2

   1 .\" Copyright (C) 2003 Free Software Foundation, Inc.
   2 .\"
   3 .\" %%%LICENSE_START(GPL_NOVERSION_ONELINE)
   4 .\" This file is distributed according to the GNU General Public License.
   5 .\" %%%LICENSE_END
   6 .\"
   7 .\"*******************************************************************
   8 .\"
   9 .\" This file was generated with po4a. Translate the source file.
  10 .\"
  11 .\"*******************************************************************
  12 .TH IO_CANCEL 2 2012\-07\-13 Linux "Linux Programmer's Manual"
  13 .SH 名前
  14 io_cancel \- 未処理の非同期 I/O 操作の取り消し
  15 .SH 書式
  16 .nf
  17 \fB#include <linux/aio_abi.h>\fP          /* 必要な型の定義 */
  18
  19 \fBint io_cancel(aio_context_t \fP\fIctx_id\fP\fB, struct iocb *\fP\fIiocb\fP\fB,\fP
  20 \fB              struct io_event *\fP\fIresult\fP\fB);\fP
  21 .fi
  22
  23 \fI注\fP: このシステムコールには glibc のラッパー関数は存在しない。「注意」の節を参照。
  24 .SH 説明
  25 .PP
  26 \fBio_cancel\fP() システムコールは、過去に \fBio_submit\fP(2) を使って登録さ
  27 れた非同期 I/O (AIO) 操作の取り消しを行おうとする。 \fIctx_id\fP 引き数は、
  28 取り消しを行う操作の AIO コンテキストの ID である。指定した AIO コンテ
  29 キストが見つかると、対象のイベントの取り消しが行われ、その後 \fIresult\fP
  30 で指されたメモリに コピーされる (このとき、完了キューへの移動は行われな
  31 い)。
  32 .SH 返り値
  33 成功した場合、 \fBio_cancel\fP()  は 0 を返す。 失敗時の返り値については、「注意」の節を参照すること。
  34 .SH エラー
  35 .TP
  36 \fBEAGAIN\fP
  37 指定された \fIiocb\fP の取り消しが行われなかった。
  38 .TP
  39 \fBEFAULT\fP
  40 データ構造の中に無効なデータを指しているものがある。
  41 .TP
  42 \fBEINVAL\fP
  43 \fIctx_id\fP で指定された AIO コンテキストが無効である。
  44 .TP
  45 \fBENOSYS\fP
  46 \fBio_cancel\fP()  はこのアーキテクチャでは実装されていない。
  47 .SH バージョン
  48 .PP
  49 非同期 I/O システム・コールは Linux 2.5 で初めて登場した。
  50 .SH 準拠
  51 .PP
  52 \fBio_cancel\fP()  は Linux 固有であり、移植を想定したプログラムで使用すべきではない。
  53 .SH 注意
  54 .\" http://git.fedorahosted.org/git/?p=libaio.git
  55 glibc はこのシステムコールのラッパー関数を提供していない。
  56 \fBsyscall\fP(2) を使ってこのシステムコールを起動することができる。
  57 しかし、たいていは、このシステムコールを呼び出したいのではなく、
  58  \fIlibaio\fP が提供している \fBio_cancel\fP ラッパー関数を呼び出したい
  59 場合がほとんどであろう。
  60
  61 .\" But glibc is confused, since <libaio.h> uses 'io_context_t' to declare
  62 .\" the system call.
  63 \fIlibaio\fP のラッパー関数では \fIctx_id\fP 引き数に別の型
  64 (\fIio_context_t\fP) が使われることに注意すること。
  65 また、\fIlibaio\fP のラッパー関数は、エラーの通知が通常の C ライブラリの
  66 慣習にしたがっておらず、エラーの場合には負のエラー番号 (エラーの節に列
  67 挙されている値の一つを負にしたもの) が返り値となる点にも注意すること。
  68 \fBsyscall\fP(2) 経由でシステムコールを起動すると、返り値は通常のエラー通
  69 知の慣習に したがってものとなり、エラーの場合には \-1 が返り、 \fIerrno\fP
  70 にエラーを示す (正の) 値が設定される。
  71 .SH 関連項目
  72 .\" .SH AUTHOR
  73 .\" Kent Yoder.
  74 \fBio_destroy\fP(2), \fBio_getevents\fP(2), \fBio_setup\fP(2), \fBio_submit\fP(2),
  75 \fBaio\fP(7)
  76 .SH この文書について
  77 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.50 の一部
  78 である。プロジェクトの説明とバグ報告に関する情報は
  79 http://www.kernel.org/doc/man\-pages/ に書かれている。