projects / thirdparty / man-pages.git / blame
| Commit | Line | Data |
|---|---|---|
| fea681da MK |
1 | .\" Copyright (C) 2001 Andries Brouwer <aeb@cwi.nl>. |
| 2 | .\" | |
| 3 | .\" Permission is granted to make and distribute verbatim copies of this | |
| 4 | .\" manual provided the copyright notice and this permission notice are | |
| 5 | .\" preserved on all copies. | |
| 6 | .\" | |
| 7 | .\" Permission is granted to copy and distribute modified versions of this | |
| 8 | .\" manual under the conditions for verbatim copying, provided that the | |
| 9 | .\" entire resulting derived work is distributed under the terms of a | |
| 10 | .\" permission notice identical to this one. | |
| 11 | .\" | |
| 12 | .\" Since the Linux kernel and libraries are constantly changing, this | |
| 13 | .\" manual page may be incorrect or out-of-date. The author(s) assume no | |
| 14 | .\" responsibility for errors or omissions, or for damages resulting from | |
| 15 | .\" the use of the information contained herein. The author(s) may not | |
| 16 | .\" have taken the same level of care in the production of this manual, | |
| 17 | .\" which is licensed free of charge, as they might when working | |
| 18 | .\" professionally. | |
| 19 | .\" | |
| 20 | .\" Formatted or processed versions of this manual, if unaccompanied by | |
| 21 | .\" the source, must acknowledge the copyright and authors of this work. | |
| 22 | .\" | |
| 23 | .TH FPURGE 3 2001-12-15 "" "Linux Programmer's Manual" | |
| 24 | .SH NAME | |
| 25 | fpurge, __fpurge \- purge a stream | |
| 26 | .SH SYNOPSIS | |
| 27 | .nf | |
| 28 | /* unsupported */ | |
| 29 | .B #include <stdio.h> | |
| 30 | .sp | |
| 31 | .BI "int fpurge(FILE *" stream ); | |
| 32 | .sp | |
| 33 | /* supported */ | |
| 34 | .B #include <stdio.h> | |
| 35 | .br | |
| 36 | .B #include <stdio_ext.h> | |
| 37 | .sp | |
| 38 | .BI "void __fpurge(FILE *" stream ); | |
| 39 | .fi | |
| 40 | .SH DESCRIPTION | |
| 41 | The function | |
| 42 | .B fpurge() | |
| 43 | clears the buffers of the given stream. | |
| 44 | For output streams this discards any unwritten output. | |
| 45 | For input streams this discards any input read from the underlying object | |
| 46 | but not yet obtained via | |
| 47 | .BR getc (3); | |
| 48 | this includes any text pushed back via \fIungetc\fP(). See also | |
| 49 | .BR fflush (3). | |
| 50 | .LP | |
| 51 | The function | |
| 52 | .B __fpurge() | |
| 53 | does precisely the same, but without returning a value. | |
| 54 | .SH "RETURN VALUE" | |
| 55 | Upon successful completion | |
| 56 | .B fpurge() | |
| 57 | returns 0. | |
| 58 | On error, it returns \-1 and sets | |
| 59 | .I errno | |
| 60 | appropriately. | |
| 61 | .SH ERRORS | |
| 62 | .TP | |
| 63 | .B EBADF | |
| 64 | .I stream | |
| 65 | is not an open stream. | |
| 66 | .SH "CONFORMING TO" | |
| 67 | These functions are nonstandard and not portable. | |
| 68 | The function | |
| 69 | .IR fpurge () | |
| 70 | was introduced in BSD 4.4 and is not available under Linux. | |
| 71 | The function | |
| 72 | .IR __fpurge () | |
| 73 | was introduced in Solaris, and is present in glibc 2.1.95 and later. | |
| 74 | .SH NOTES | |
| 75 | Usually it is a mistake to want to discard input buffers. | |
| 76 | .SH "SEE ALSO" | |
| 77 | .BR fclean (3), | |
| 78 | .BR fflush (3), | |
| 79 | .BR setbuf (3), | |
| 80 | .BR stdio_ext (3) |