libexplain/putc_on_error.c File Reference

#include <libexplain/ac/errno.h>
#include <libexplain/ac/stdio.h>
#include <libexplain/putc.h>
#include <libexplain/output.h>

Go to the source code of this file.

Functions
void	explain_putc_on_error_failed (int c, FILE *fp)
int	explain_putc_on_error (int c, FILE *fp)

---

Function Documentation

int explain_putc_on_error	(	int	c,
		FILE *	fp
	)

The explain_putc_on_error function is used to call the putc(3) system call. On failure an explanation will be printed to stderr, obtained from the explain_putc(3) function.

This function is intended to be used in a fashion similar to the following example:

 if (explain_putc_on_error(c, fp) == EOF)
 {
     ...cope with error
     ...no need to print error message
 }

Parameters:

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

Returns:

The value returned by the wrapped putc(3) system call.

Definition at line 40 of file putc_on_error.c.

void explain_putc_on_error_failed	(	int	c,
		FILE *	fp
	)

Private function, provided for the explusive use of the explain_putc_on_error inline function. Clients of libexplain must not use it, because it's existence and signature is subject to change without notice. Think of it as a C++ private method.

Definition at line 27 of file putc_on_error.c.