xref: /illumos-gate/usr/src/man/man3c/ferror.3c (revision cd62a92d4a964bfe61d35ba2301b69e65e22a509)
1*cd62a92dSRobert Mustacchi.\"
2*cd62a92dSRobert Mustacchi.\"
3*cd62a92dSRobert Mustacchi.\" The contents of this file are subject to the terms of the
4*cd62a92dSRobert Mustacchi.\" Common Development and Distribution License (the "License").
5*cd62a92dSRobert Mustacchi.\" You may not use this file except in compliance with the License.
6*cd62a92dSRobert Mustacchi.\"
7*cd62a92dSRobert Mustacchi.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
8*cd62a92dSRobert Mustacchi.\" or http://www.opensolaris.org/os/licensing.
9*cd62a92dSRobert Mustacchi.\" See the License for the specific language governing permissions
10*cd62a92dSRobert Mustacchi.\" and limitations under the License.
11*cd62a92dSRobert Mustacchi.\"
12*cd62a92dSRobert Mustacchi.\" When distributing Covered Code, include this CDDL HEADER in each
13*cd62a92dSRobert Mustacchi.\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
14*cd62a92dSRobert Mustacchi.\" If applicable, add the following below this CDDL HEADER, with the
15*cd62a92dSRobert Mustacchi.\" fields enclosed by brackets "[]" replaced with your own identifying
16*cd62a92dSRobert Mustacchi.\" information: Portions Copyright [yyyy] [name of copyright owner]
17*cd62a92dSRobert Mustacchi.\"
18*cd62a92dSRobert Mustacchi.\" Copyright 1989 AT&T
19*cd62a92dSRobert Mustacchi.\" Copyright (c) 2005, Sun Microsystems, Inc.  All Rights Reserved
20*cd62a92dSRobert Mustacchi.\" Copyright 2020 Robert Mustacchi
21*cd62a92dSRobert Mustacchi.\"
22*cd62a92dSRobert Mustacchi.Dd "March 25, 2020"
23*cd62a92dSRobert Mustacchi.Dt FERROR 3C
24*cd62a92dSRobert Mustacchi.Os
25*cd62a92dSRobert Mustacchi.Sh NAME
26*cd62a92dSRobert Mustacchi.Nm ferror ,
27*cd62a92dSRobert Mustacchi.Nm feof ,
28*cd62a92dSRobert Mustacchi.Nm clearerr ,
29*cd62a92dSRobert Mustacchi.Nm fileno
30*cd62a92dSRobert Mustacchi.Nd stream status inquiries
31*cd62a92dSRobert Mustacchi.Sh SYNOPSIS
32*cd62a92dSRobert Mustacchi.In stdio.h
33*cd62a92dSRobert Mustacchi.Ft int
34*cd62a92dSRobert Mustacchi.Fo ferror
35*cd62a92dSRobert Mustacchi.Fa "FILE *stream"
36*cd62a92dSRobert Mustacchi.Fc
37*cd62a92dSRobert Mustacchi.Ft int
38*cd62a92dSRobert Mustacchi.Fo feof
39*cd62a92dSRobert Mustacchi.Fa "FILE *stream"
40*cd62a92dSRobert Mustacchi.Fc
41*cd62a92dSRobert Mustacchi.Ft void
42*cd62a92dSRobert Mustacchi.Fo clearerr
43*cd62a92dSRobert Mustacchi.Fa "FILE *stream"
44*cd62a92dSRobert Mustacchi.Fc
45*cd62a92dSRobert Mustacchi.Ft int
46*cd62a92dSRobert Mustacchi.Fo fileno
47*cd62a92dSRobert Mustacchi.Fa "FILE *stream"
48*cd62a92dSRobert Mustacchi.Fc
49*cd62a92dSRobert Mustacchi.Sh DESCRIPTION
50*cd62a92dSRobert MustacchiThe
51*cd62a92dSRobert Mustacchi.Fn ferror
52*cd62a92dSRobert Mustacchifunction returns a non-zero value when an error has
53*cd62a92dSRobert Mustacchipreviously occurred reading from or writing to the named
54*cd62a92dSRobert Mustacchi.Fa stream
55*cd62a92dSRobert Mustacchi.Po
56*cd62a92dSRobert Mustacchisee
57*cd62a92dSRobert Mustacchi.Xr Intro 3
58*cd62a92dSRobert Mustacchi.Pc .
59*cd62a92dSRobert MustacchiIt returns
60*cd62a92dSRobert Mustacchi.Sy 0
61*cd62a92dSRobert Mustacchiotherwise.
62*cd62a92dSRobert Mustacchi.Pp
63*cd62a92dSRobert MustacchiThe
64*cd62a92dSRobert Mustacchi.Fn feof
65*cd62a92dSRobert Mustacchifunction returns a non-zero value when
66*cd62a92dSRobert Mustacchi.Sy EOF
67*cd62a92dSRobert Mustacchihas previously been detected reading the named input
68*cd62a92dSRobert Mustacchi.Fa stream .
69*cd62a92dSRobert MustacchiIt returns
70*cd62a92dSRobert Mustacchi.Sy 0
71*cd62a92dSRobert Mustacchiotherwise.
72*cd62a92dSRobert Mustacchi.Pp
73*cd62a92dSRobert MustacchiThe
74*cd62a92dSRobert Mustacchi.Fn clearerr
75*cd62a92dSRobert Mustacchifunction resets the error indicator and
76*cd62a92dSRobert Mustacchi.Sy EOF
77*cd62a92dSRobert Mustacchiindicator to 0 on the named
78*cd62a92dSRobert Mustacchi.Fa stream .
79*cd62a92dSRobert Mustacchi.Pp
80*cd62a92dSRobert MustacchiThe
81*cd62a92dSRobert Mustacchi.Fn fileno
82*cd62a92dSRobert Mustacchifunction returns the integer file descriptor associated with
83*cd62a92dSRobert Mustacchithe named
84*cd62a92dSRobert Mustacchi.Fa stream ;
85*cd62a92dSRobert Mustacchisee
86*cd62a92dSRobert Mustacchi.Xr open 2 .
87*cd62a92dSRobert MustacchiStreams that are not associated with a file descriptor such as those
88*cd62a92dSRobert Mustacchithat were created through the
89*cd62a92dSRobert Mustacchi.Xr fmemopen 3C
90*cd62a92dSRobert Mustacchior
91*cd62a92dSRobert Mustacchi.Xr open_memstream 3C
92*cd62a92dSRobert Mustacchifunctions will return
93*cd62a92dSRobert Mustacchi.Sy -1 .
94*cd62a92dSRobert Mustacchi.Sh INTERFACE STABILITY
95*cd62a92dSRobert Mustacchi.Sy Standard
96*cd62a92dSRobert Mustacchi.Sh MT-LEVEL
97*cd62a92dSRobert Mustacchi.Sy MT-Safe
98*cd62a92dSRobert Mustacchi.Sh SEE ALSO
99*cd62a92dSRobert Mustacchi.Xr Intro 2 ,
100*cd62a92dSRobert Mustacchi.Xr open 2 ,
101*cd62a92dSRobert Mustacchi.Xr fmemopen 3C ,
102*cd62a92dSRobert Mustacchi.Xr fopen 3C ,
103*cd62a92dSRobert Mustacchi.Xr open_memstream 3C ,
104*cd62a92dSRobert Mustacchi.Xr stdio 3C
105