usr/src/man/man3c/aiocancel.3c

   1 '\" te
   2 .\" Copyright (c) 2008 Sun Microsystems, Inc.  All Rights Reserved.
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH AIOCANCEL 3C "Feb 5, 1997"
   7 .SH NAME
   8 aiocancel \- cancel an asynchronous operation
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/asynch.h>
  13
  14 \fBint\fR \fBaiocancel\fR(\fBaio_result_t *\fR\fIresultp\fR);
  15 .fi
  16
  17 .SH DESCRIPTION
  18 .sp
  19 .LP
  20 \fBaiocancel()\fR cancels the asynchronous operation associated with the result
  21 buffer pointed to by \fIresultp\fR. It may not be possible to immediately
  22 cancel an operation which is in progress and in this case, \fBaiocancel()\fR
  23 will not wait to cancel it.
  24 .sp
  25 .LP
  26 Upon successful completion, \fBaiocancel()\fR returns  \fB0\fR and the
  27 requested operation is cancelled.  The application will not receive the
  28 \fBSIGIO\fR completion signal for an asynchronous operation that is
  29 successfully cancelled.
  30 .SH RETURN VALUES
  31 .sp
  32 .LP
  33 Upon successful completion, \fBaiocancel()\fR returns \fB0\fR. Upon failure,
  34 \fBaiocancel()\fR returns \fB\(mi1\fR and sets \fBerrno\fR to indicate the
  35 error.
  36 .SH ERRORS
  37 .sp
  38 .LP
  39 \fBaiocancel()\fR will fail if any of the following are true:
  40 .sp
  41 .ne 2
  42 .na
  43 \fB\fBEACCES\fR\fR
  44 .ad
  45 .RS 10n
  46 The parameter \fIresultp\fR does not correspond to any outstanding asynchronous
  47 operation, although there is at least one currently outstanding.
  48 .RE
  49
  50 .sp
  51 .ne 2
  52 .na
  53 \fB\fBEFAULT\fR\fR
  54 .ad
  55 .RS 10n
  56 \fIresultp\fR points to an address outside the address space of the requesting
  57 process.  See \fBNOTES\fR.
  58 .RE
  59
  60 .sp
  61 .ne 2
  62 .na
  63 \fB\fBEINVAL\fR\fR
  64 .ad
  65 .RS 10n
  66 There are not any outstanding requests to cancel.
  67 .RE
  68
  69 .SH ATTRIBUTES
  70 .sp
  71 .LP
  72 See \fBattributes\fR(5) for descriptions of the following attributes:
  73 .sp
  74
  75 .sp
  76 .TS
  77 box;
  78 c | c
  79 l | l .
  80 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  81 _
  82 MT-Level        Safe
  83 .TE
  84
  85 .SH SEE ALSO
  86 .sp
  87 .LP
  88 \fBaioread\fR(3C), \fBaiowait\fR(3C), \fBattributes\fR(5)
  89 .SH NOTES
  90 .sp
  91 .LP
  92 Passing an illegal address as \fIresultp\fR will result in setting \fBerrno\fR
  93 to \fBEFAULT\fR \fIonly\fR if it is detected by the application process.