summaryrefslogtreecommitdiffstats
path: root/man3/ferror.3
diff options
context:
space:
mode:
Diffstat (limited to 'man3/ferror.3')
-rw-r--r--man3/ferror.3106
1 files changed, 106 insertions, 0 deletions
diff --git a/man3/ferror.3 b/man3/ferror.3
new file mode 100644
index 000000000..48eb69e50
--- /dev/null
+++ b/man3/ferror.3
@@ -0,0 +1,106 @@
+.\" Copyright (c) 1990, 1991 The Regents of the University of California.
+.\" All rights reserved.
+.\"
+.\" This code is derived from software contributed to Berkeley by
+.\" Chris Torek and the American National Standards Committee X3,
+.\" on Information Processing Systems.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\" notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\" notice, this list of conditions and the following disclaimer in the
+.\" documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\" must display the following acknowledgement:
+.\" This product includes software developed by the University of
+.\" California, Berkeley and its contributors.
+.\" 4. Neither the name of the University nor the names of its contributors
+.\" may be used to endorse or promote products derived from this software
+.\" without specific prior written permission.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.\" @(#)ferror.3 6.8 (Berkeley) 6/29/91
+.\"
+.\"
+.\" Converted for Linux, Mon Nov 29 14:24:40 1993, faith@cs.unc.edu
+.\" Added remark on EBADF for fileno, aeb, 2001-03-22
+.\"
+.TH FERROR 3 2001-10-16 "" "Linux Programmer's Manual"
+.SH NAME
+clearerr, feof, ferror, fileno \- check and reset stream status
+.SH SYNOPSIS
+.B #include <stdio.h>
+.sp
+.BI "void clearerr(FILE *" stream );
+.br
+.BI "int feof(FILE *" stream );
+.br
+.BI "int ferror(FILE *" stream );
+.br
+.BI "int fileno(FILE *" stream );
+.SH DESCRIPTION
+The function
+.B clearerr
+clears the end-of-file and error indicators for the stream pointed to by
+.IR stream .
+.PP
+The function
+.B feof
+tests the end-of-file indicator for the stream pointed to by
+.IR stream ,
+returning non-zero if it is set. The end-of-file indicator can only be
+cleared by the function
+.BR clearerr .
+.PP
+The function
+.B ferror
+tests the error indicator for the stream pointed to by
+.IR stream ,
+returning non-zero if it is set. The error indicator can only be reset by
+the
+.B clearerr
+function.
+.PP
+The function
+.B fileno
+examines the argument
+.I stream
+and returns its integer descriptor.
+.PP
+For non-locking counterparts, see
+.BR unlocked_stdio (3).
+.SH ERRORS
+These functions should not fail and do not set the external variable
+.IR errno .
+(However, in case
+.B fileno
+detects that its argument is not a valid stream, it must
+return \-1 and set
+.I errno
+to
+.BR EBADF .)
+.SH "CONFORMING TO"
+The functions
+.BR clearerr ,
+.BR feof ,
+and
+.BR ferror
+conform to X3.159-1989 (``ANSI C'').
+.SH "SEE ALSO"
+.BR open (2),
+.BR stdio (3),
+.BR unlocked_stdio (3)