share/man/man9f/bioerror.9f

   1 '\" te
   2 .\" Copyright (c) 1994, Sun Microsystems, Inc.
   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 BIOERROR 9F "April 9, 2016"
   7 .SH NAME
   8 bioerror \- indicate error in buffer header
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/types.h>
  13 #include <sys/buf.h>
  14 #include <sys/ddi.h>
  15
  16
  17
  18 \fBvoid\fR \fBbioerror\fR(\fBstruct buf *\fR\fIbp\fR, \fBint\fR \fIerror\fR);
  19 .fi
  20
  21 .SH INTERFACE LEVEL
  22 .LP
  23 Solaris DDI specific (Solaris DDI)
  24 .SH PARAMETERS
  25 .ne 2
  26 .na
  27 \fB\fIbp\fR \fR
  28 .ad
  29 .RS 10n
  30 Pointer to the \fBbuf\fR(9S) structure describing the transfer.
  31 .RE
  32
  33 .sp
  34 .ne 2
  35 .na
  36 \fB\fIerror\fR \fR
  37 .ad
  38 .RS 10n
  39 Error number to be set, or zero to clear an error indication.
  40 .RE
  41
  42 .SH DESCRIPTION
  43 .LP
  44 If \fIerror\fR is non-zero, \fBbioerror()\fR indicates an error has occurred in
  45 the \fBbuf\fR(9S) structure. A subsequent call to \fBgeterror\fR(9F) will
  46 return \fIerror\fR.
  47 .sp
  48 .LP
  49 If \fIerror\fR is  \fB0\fR, the error indication is cleared and a subsequent
  50 call to \fBgeterror\fR(9F) will return  \fB0\fR.
  51 .SH CONTEXT
  52 .LP
  53 \fBbioerror()\fR can be called from any context.
  54 .SH SEE ALSO
  55 .LP
  56 \fBstrategy\fR(9E), \fBgeterror\fR(9F), \fBgetrbuf\fR(9F), \fBbuf\fR(9S)