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