[MAN] fpurge

Content-type: text/html; charset=UTF-8

FPURGE

Section: Misc. Reference Manual Pages (3bsd)
Index Return to Main Contents

---

BSD mandoc
 

NAME

fpurge - flush a stream  

LIBRARY

Lb libbsd  

SYNOPSIS

In stdio.h (See libbsd(7) for include usage.) Ft int Fn fpurge FILE *stream  

DESCRIPTION

The function Fn fpurge erases any input or output buffered in the given Fa 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 getc(3); this includes any text pushed back via ungetc(3).  

RETURN VALUES

Upon successful completion 0 is returned. Otherwise, EOF is returned and the global variable errno is set to indicate the error.  

ERRORS

Bq Er EBADF

Fa stream is not an open stream.

 

SEE ALSO

fclose(3), fopen(3), setvbuf(3)  

HISTORY

The Fn fpurge function first appeared in BSD 4.4 Lite

---

 

Index

NAME

LIBRARY

SYNOPSIS

DESCRIPTION

RETURN VALUES

ERRORS

SEE ALSO

HISTORY

---

This document was created by man2html, using the manual pages.
Time: 04:45:39 GMT, September 16, 2022 Content-type: text/html; charset=UTF-8

FPURGE

Section: Linux Programmer's Manual (3)
Updated: 2017-09-15
Index Return to Main Contents

---

 

NAME

fpurge, __fpurge - purge a stream  

SYNOPSIS

/* unsupported */
#include <stdio.h>

int fpurge(FILE *stream);

/* supported */
#include <stdio.h>
#include <stdio_ext.h>

void  __fpurge(FILE *stream);

 

DESCRIPTION

The function 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 getc(3); this includes any text pushed back via ungetc(3). See also fflush(3).

The function __fpurge() does precisely the same, but without returning a value.  

RETURN VALUE

Upon successful completion fpurge() returns 0. On error, it returns -1 and sets errno appropriately.  

ERRORS

EBADF

stream is not an open stream.

 

ATTRIBUTES

For an explanation of the terms used in this section, see attributes(7).

Interface	Attribute	Value
__fpurge()	Thread safety	MT-Safe race:stream

 

CONFORMING TO

These functions are nonstandard and not portable. The function fpurge() was introduced in 4.4BSD and is not available under Linux. The function __fpurge() was introduced in Solaris, and is present in glibc 2.1.95 and later.  

NOTES

Usually it is a mistake to want to discard input buffers.  

SEE ALSO

fflush(3), setbuf(3), stdio_ext(3)  

COLOPHON

This page is part of release 4.15 of the Linux man-pages project. A description of the project, information about reporting bugs, and the latest version of this page, can be found at https://www.kernel.org/doc/man-pages/.

---

 

Index

NAME

SYNOPSIS

DESCRIPTION

RETURN VALUE

ERRORS

ATTRIBUTES

CONFORMING TO

NOTES

SEE ALSO

COLOPHON

---

This document was created by man2html, using the manual pages.
Time: 04:45:46 GMT, September 16, 2022