manual/LDP_man-pages/draft/man3/aio_cancel.3

   1 .\" Copyright (c) 2003 Andries Brouwer (aeb@cwi.nl)
   2 .\"
   3 .\" This is free documentation; you can redistribute it and/or
   4 .\" modify it under the terms of the GNU General Public License as
   5 .\" published by the Free Software Foundation; either version 2 of
   6 .\" the License, or (at your option) any later version.
   7 .\"
   8 .\" The GNU General Public License's references to "object code"
   9 .\" and "executables" are to be interpreted as the output of any
  10 .\" document formatting or typesetting system, including
  11 .\" intermediate and printed output.
  12 .\"
  13 .\" This manual is distributed in the hope that it will be useful,
  14 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 .\" GNU General Public License for more details.
  17 .\"
  18 .\" You should have received a copy of the GNU General Public
  19 .\" License along with this manual; if not, write to the Free
  20 .\" Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111,
  21 .\" USA.
  22 .\"
  23 .\" Japanese Version Copyright (c) 2004 Yuichi SATO
  24 .\"         all rights reserved.
  25 .\" Translated Thu Jul 01 02:44:30 JST 2004
  26 .\"         by Yuichi SATO <ysato444@yahoo.co.jp>
  27 .\"
  28 .TH AIO_CANCEL 3 2003-11-14  "" "Linux Programmer's Manual"
  29 .\"O .SH NAME
  30 .SH 名前
  31 .\"O aio_cancel \- cancel an outstanding asynchronous I/O request
  32 aio_cancel \- 完了していない非同期 I/O リクエストをキャンセルする
  33 .\"O .SH SYNOPSIS
  34 .SH 書式
  35 .B "#include <aio.h>"
  36 .sp
  37 .BI "int aio_cancel(int " fd ", struct aiocb *" aiocbp );
  38 .sp
  39 .\"O Link with \fI\-lrt\fP.
  40 \fI\-lrt\fP でリンクする。
  41 .\"O .SH DESCRIPTION
  42 .SH 説明
  43 .\"O The
  44 .\"O .BR aio_cancel ()
  45 .\"O function attempts to cancel outstanding asynchronous I/O requests
  46 .\"O for the file descriptor
  47 .\"O .IR fd .
  48 .BR aio_cancel ()
  49 関数は、ファイルディスクリプタ
  50 .I fd
  51 についての完了していない非同期 I/O リクエストをキャンセルしようとする。
  52 .\"O If
  53 .\"O .I aiocbp
  54 .\"O is NULL, all such requests are canceled.
  55 .\"O Otherwise, only the request
  56 .\"O described by the control block pointed to by
  57 .\"O .I aiocbp
  58 .\"O is canceled.
  59 .I aiocbp
  60 が NULL の場合、そのような全てのリクエストがキャンセルされる。
  61 .I aiocbp
  62 が NULL でない場合、
  63 .I aiocbp
  64 で指された制御ブロックで記述されたリクエストのみがキャンセルされる。
  65 .LP
  66 .\"O Normal asynchronous notification occurs for canceled requests.
  67 キャンセルされたリクエストに対して、通常の非同期通知が起こる。
  68 .\"O The request return status is set to \-1, and the request error status
  69 .\"O is set to
  70 .\"O .BR ECANCELED .
  71 リクエストの返り値は \-1 に設定され、
  72 リクエストのエラー状態は
  73 .B ECANCELED
  74 に設定される。
  75 .\"O The control block of requests that cannot be canceled is not changed.
  76 キャンセルできなかったリクエストの制御ブロックは変更されない。
  77 .LP
  78 .\"O If
  79 .\"O .I aiocbp
  80 .\"O is not NULL, and
  81 .\"O .I fd
  82 .\"O differs from the file descriptor with which the asynchronous operation
  83 .\"O was initiated, unspecified results occur.
  84 .I aiocbp
  85 が NULL でなく、かつ
  86 .I fd
  87 が非同期操作が開始されたファイルディスクリプタと異なる場合、
  88 生じる結果は不定である。
  89 .LP
  90 .\"O Which operations are cancellable is implementation-defined.
  91 どの操作をキャンセルできるかは、実装定義である。
  92 .\"O .\" FreeBSD: not those on raw disk devices.
  93 .\" FreeBSD: raw ディスクデバイスへのリクエストはキャンセルできない。
  94 .\"O .SH "RETURN VALUE"
  95 .SH 返り値
  96 .\"O This function returns
  97 .\"O .B AIO_CANCELED
  98 .\"O if all requests were successfully
  99 .\"O canceled.
 100 .\"O It returns
 101 .\"O .B AIO_NOTCANCELED
 102 .\"O when at least one of the
 103 .\"O requests specified was not canceled because it was in progress.
 104 全てのリクエストのキャンセルが成功した場合、この関数は
 105 .B AIO_CANCELED
 106 を返す。
 107 指定されたリクエストのうち少なくとも 1 つが進行中であるために
 108 キャンセルできなかった場合は、
 109 .B AIO_NOTCANCELED
 110 が返される。
 111 .\"O In this case one may check the status of individual requests using
 112 .\"O .BR aio_error (3).
 113 この場合は、
 114 .BR aio_error (3)
 115 を使って個々のリクエストの状態をチェックすることができる。
 116 .\"O This function returns
 117 .\"O .B AIO_ALLDONE
 118 .\"O when all requests had
 119 .\"O been completed already before this call.
 120 呼び出される前に全てのリクエストが完了していた場合、
 121 この関数は
 122 .B AIO_ALLDONE
 123 を返す。
 124 .\"O When some error occurs, \-1 is returned, and
 125 .\"O .I errno
 126 .\"O is set appropriately.
 127 何らかのエラーが起こった場合は、\-1 が返されて、
 128 .I errno
 129 が適切に設定される。
 130 .\"O .SH ERRORS
 131 .SH エラー
 132 .TP
 133 .B EBADF
 134 .\"O .I fd
 135 .\"O is not a valid file descriptor.
 136 .I fd
 137 が有効なファイルディスクリプタでない。
 138 .\"O .SH "CONFORMING TO"
 139 .SH 準拠
 140 POSIX.1-2001.
 141 .\"O .SH "SEE ALSO"
 142 .SH 関連項目
 143 .BR aio_error (3),
 144 .BR aio_fsync (3),
 145 .BR aio_read (3),
 146 .BR aio_return (3),
 147 .BR aio_suspend (3),
 148 .BR aio_write (3)