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