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

   1 '\" te
   2 .\"  Copyright 1989 AT&T  Copyright (c) 2005, 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 FERROR 3C "Feb 17, 2005"
   7 .SH NAME
   8 ferror, feof, clearerr, fileno \- stream status inquiries
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <stdio.h>
  13
  14 \fBint\fR \fBferror\fR(\fBFILE *\fR\fIstream\fR);
  15 .fi
  16
  17 .LP
  18 .nf
  19 \fBint\fR \fBfeof\fR(\fBFILE *\fR\fIstream\fR);
  20 .fi
  21
  22 .LP
  23 .nf
  24 \fBvoid\fR \fBclearerr\fR(\fBFILE *\fR\fIstream\fR);
  25 .fi
  26
  27 .LP
  28 .nf
  29 \fBint\fR \fBfileno\fR(\fBFILE *\fR\fIstream\fR);
  30 .fi
  31
  32 .SH DESCRIPTION
  33 .sp
  34 .LP
  35 The \fBferror()\fR function returns a non-zero value when an error has
  36 previously occurred reading from or writing to the named \fIstream\fR (see
  37 \fBIntro\fR(3)). It returns \fB0\fR otherwise.
  38 .sp
  39 .LP
  40 The \fBfeof()\fR function returns a non-zero value when \fBEOF\fR has
  41 previously been detected reading the named input \fIstream\fR. It returns
  42 \fB0\fR otherwise.
  43 .sp
  44 .LP
  45 The \fBclearerr()\fR function resets the error indicator and \fBEOF\fR
  46 indicator to 0 on the named \fIstream\fR.
  47 .sp
  48 .LP
  49 The \fBfileno()\fR function returns the integer file descriptor associated with
  50 the named \fIstream\fR; see \fBopen\fR(2).
  51 .SH ATTRIBUTES
  52 .sp
  53 .LP
  54 See \fBattributes\fR(5) for descriptions of the following attributes:
  55 .sp
  56
  57 .sp
  58 .TS
  59 box;
  60 c | c
  61 l | l .
  62 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  63 _
  64 Interface Stability     Standard
  65 _
  66 MT-Level        MT-Safe
  67 .TE
  68
  69 .SH SEE ALSO
  70 .sp
  71 .LP
  72 \fBopen\fR(2), \fBIntro\fR(3), \fBfopen\fR(3C), \fBstdio\fR(3C),
  73 \fBattributes\fR(5), \fBstandards\fR(5)