blob: 4057c90cca22ef2288853b05422f8b7f72389b4c (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
|
'\" t
.\" Copyright (C) 2001 Andries Brouwer <aeb@cwi.nl>.
.\"
.\" SPDX-License-Identifier: Linux-man-pages-copyleft
.\"
.TH fpurge 3 2024-05-02 "Linux man-pages (unreleased)"
.SH NAME
fpurge, __fpurge \- purge a stream
.SH LIBRARY
Standard C library
.RI ( libc ", " \-lc )
.SH SYNOPSIS
.nf
/* unsupported */
.B #include <stdio.h>
.P
.BI "int fpurge(FILE *" stream );
.P
/* supported */
.B #include <stdio.h>
.B #include <stdio_ext.h>
.P
.BI "void __fpurge(FILE *" stream );
.fi
.SH DESCRIPTION
The function
.BR fpurge ()
clears the buffers of the given stream.
For output streams this discards any unwritten output.
For input streams this discards any input read from the underlying object
but not yet obtained via
.BR getc (3);
this includes any text pushed back via
.BR ungetc (3).
See also
.BR fflush (3).
.P
The function
.BR __fpurge ()
does precisely the same, but without returning a value.
.SH RETURN VALUE
Upon successful completion
.BR fpurge ()
returns 0.
On error, it returns \-1 and sets
.I errno
to indicate the error.
.SH ERRORS
.TP
.B EBADF
.I stream
is not an open stream.
.SH ATTRIBUTES
For an explanation of the terms used in this section, see
.BR attributes (7).
.TS
allbox;
lbx lb lb
l l l.
Interface Attribute Value
T{
.na
.nh
.BR __fpurge ()
T} Thread safety MT-Safe race:stream
.TE
.SH STANDARDS
None.
.SH HISTORY
.TP
.BR fpurge ()
4.4BSD.
Not available under Linux.
.TP
.BR __fpurge ()
Solaris, glibc 2.1.95.
.SH NOTES
Usually it is a mistake to want to discard input buffers.
.SH SEE ALSO
.\" .BR fclean (3),
.BR fflush (3),
.BR setbuf (3),
.BR stdio_ext (3)
|
