explain_fpurge_or_die(3) [debian man page]

explain_fpurge_or_die(3)				     Library Functions Manual					  explain_fpurge_or_die(3)

NAME

       explain_fpurge_or_die - purge a stream and report errors

SYNOPSIS

       #include <libexplain/fpurge.h>
       void explain_fpurge_or_die(FILE *fp);
       int explain_fpurge_on_error(FILE *fp);

DESCRIPTION

       The explain_fpurge_or_die function is used to call the fpurge(3) system call. On failure an explanation will be printed to stderr, obtained
       from the explain_fpurge(3) function, and then the process terminates by calling exit(EXIT_FAILURE).

       The explain_fpurge_on_error function is used to call the fpurge(3) system call. On failure  an  explanation  will  be  printed  to  stderr,
       obtained from the explain_fpurge(3) function, but still returns to the caller.

       fp      The fp, exactly as to be passed to the fpurge(3) system call.

RETURN VALUE

       The  explain_fpurge_or_die  function  only  returns  on	success, see fpurge(3) for more information. On failure, prints an explanation and
       exits, it does not return.

       The explain_fpurge_on_error function always returns the value return by the wrapped fpurge(3) system call.

EXAMPLE

       The explain_fpurge_or_die function is intended to be used in a fashion similar to the following example:
	      explain_fpurge_or_die(fp);

SEE ALSO

       fpurge(3)
	       purge a stream

       explain_fpurge(3)
	       explain fpurge(3) errors

       exit(2) terminate the calling process

COPYRIGHT

       libexplain version 0.52
       Copyright (C) 2010 Peter Miller

															  explain_fpurge_or_die(3)

FPURGE(3)						     Linux Programmer's Manual							 FPURGE(3)

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/.

								    2017-09-15								 FPURGE(3)