libexplain/vfprintf_or_die.c File Reference

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

Go to the source code of this file.

Functions
void	explain_vfprintf_or_die (FILE *fp, const char *format, va_list ap)
int	explain_vfprintf_on_error (FILE *fp, const char *format, va_list ap)

---

Function Documentation

int explain_vfprintf_on_error	(	FILE *	fp,
		const char *	format,
		va_list	ap
	)

The explain_vfprintf_on_error function is used to call the vfprintf(3) system call. On failure an explanation will be printed to stderr, obtained from the explain_vfprintf(3) function.

Parameters:

fp	The fp, exactly as to be passed to the vfprintf(3) system call.
format	The format, exactly as to be passed to the vfprintf(3) system call.
ap	The ap, exactly as to be passed to the vfprintf(3) system call.

Returns:

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

Example:

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

 if (explain_vfprintf_on_error(fp, format, ap) < 0)
 {
     ...cope with error
     ...no need to print error message
 }

Definition at line 38 of file vfprintf_or_die.c.

void explain_vfprintf_or_die	(	FILE *	fp,
		const char *	format,
		va_list	ap
	)

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

Parameters:

fp	The fp, exactly as to be passed to the vfprintf(3) system call.
format	The format, exactly as to be passed to the vfprintf(3) system call.
ap	The ap, exactly as to be passed to the vfprintf(3) system call.

Returns:

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

Example:

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

 explain_vfprintf_or_die(fp, format, ap);

Definition at line 28 of file vfprintf_or_die.c.