libexplain/vprintf_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/vprintf.h>

Go to the source code of this file.

Functions
int	explain_vprintf_or_die (const char *format, va_list ap)
int	explain_vprintf_on_error (const char *format, va_list ap)

---

Function Documentation

int explain_vprintf_on_error	(	const char *	format,
		va_list	ap
	)

The explain_vprintf_on_error function is used to call the vprintf(3) system call. On failure an explanation will be printed to stderr, obtained from the explain_vprintf(3) function.

Parameters:

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

Returns:

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

Example:

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

 errno = EINVAL;
 int result = explain_vprintf_on_error(format, ap);
 if (result < 0)
 {
     ...cope with error
     ...no need to print error message
 }

Definition at line 42 of file vprintf_or_die.c.

int explain_vprintf_or_die	(	const char *	format,
		va_list	ap
	)

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

Parameters:

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

Returns:

This function only returns on success, see vprintf(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:

 int result = explain_vprintf_or_die(format, ap);

Definition at line 28 of file vprintf_or_die.c.