share/man/man9f/geterror.9f

   1 '\" te
   2 .\" Copyright (c) 2006, Sun Microsystems, Inc. All Rights Reserved.
   3 .\" Copyright 1989 AT&T
   4 .\" 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.
   5 .\" 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.
   6 .\" 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]
   7 .TH GETERROR 9F "Jan 16, 2006"
   8 .SH NAME
   9 geterror \- return \fBI/O\fR error
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 #include <sys/types.h>
  14 #include <sys/buf.h>
  15 #include <sys/ddi.h>
  16
  17
  18
  19 \fBint\fR \fBgeterror\fR(\fBstruct buf *\fR\fIbp\fR);
  20 .fi
  21
  22 .SH INTERFACE LEVEL
  23 .sp
  24 .LP
  25 Architecture independent level 1 (DDI/DKI).
  26 .SH PARAMETERS
  27 .sp
  28 .ne 2
  29 .na
  30 \fB\fIbp\fR\fR
  31 .ad
  32 .RS 6n
  33 Pointer to a \fBbuf\fR(9S) structure.
  34 .RE
  35
  36 .SH DESCRIPTION
  37 .sp
  38 .LP
  39 The \fBgeterror()\fR function returns the error number  from the error field of
  40 the  buffer header structure.
  41 .SH RETURN VALUES
  42 .sp
  43 .LP
  44 An error number indicating the error condition of the \fBI/O\fR request is
  45 returned. If the \fBI/O\fR request completes successfully, \fB0\fR is returned.
  46 .SH CONTEXT
  47 .sp
  48 .LP
  49 The \fBgeterror()\fR function can be called from user, interrupt, or kernel
  50 context.
  51 .SH SEE ALSO
  52 .sp
  53 .LP
  54 \fBbuf\fR(9S)
  55 .sp
  56 .LP
  57 \fIWriting Device Drivers\fR