libexplain/fopen_or_die.c File Reference

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

Go to the source code of this file.

Functions
FILE *	explain_fopen_on_error (const char *pathname, const char *flags)
FILE *	explain_fopen_or_die (const char *pathname, const char *flags)

---

Function Documentation

FILE* explain_fopen_on_error	(	const char *	pathname,
		const char *	flags
	)

The explain_fopen_on_error function is used to call the fopen(3) system call. On failure an explanation will be printed to stderr, obtained from the explain_fopen(3) function.

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

 if (explain_fopen_on_error(pathname, flags) < 0)
 {
     ...cope with error
     ...no need to print error message
 }

Parameters:

pathname	The pathname, exactly as to be passed to the fopen(3) system call.
flags	The flags, exactly as to be passed to the fopen(3) system call.

Returns:

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

Definition at line 28 of file fopen_or_die.c.

FILE* explain_fopen_or_die	(	const char *	pathname,
		const char *	flags
	)

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

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

 explain_fopen_or_die(pathname, flags);

Parameters:

pathname	The pathname, exactly as to be passed to the fopen(3) system call.
flags	The flags, exactly as to be passed to the fopen(3) system call.

Returns:

This function only returns on success. On failure, prints an explanation and exits, it does not return.

Definition at line 47 of file fopen_or_die.c.