libexplain/fgets_or_die.c File Reference

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

Go to the source code of this file.

Functions
char *	explain_fgets_on_error (char *data, int data_size, FILE *fp)
char *	explain_fgets_or_die (char *data, int data_size, FILE *fp)

---

Function Documentation

char* explain_fgets_on_error	(	char *	data,
		int	data_size,
		FILE *	fp
	)

The explain_fgets_on_error function is used to call the fgets(3) system call. On failure an explanation will be printed to stderr, obtained from the explain_fgets(3) function.

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

 if (explain_fgets_on_error(data, data_size, fp) < 0)
 {
     ...cope with error
     ...no need to print error message
 }

Parameters:

data	The data, exactly as to be passed to the fgets(3) system call.
data_size	The data_size, exactly as to be passed to the fgets(3) system call.
fp	The fp, exactly as to be passed to the fgets(3) system call.

Returns:

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

Definition at line 27 of file fgets_or_die.c.

char* explain_fgets_or_die	(	char *	data,
		int	data_size,
		FILE *	fp
	)

The explain_fgets_or_die function is used to call the fgets(3) system call. On failure an explanation will be printed to stderr, obtained from the explain_fgets(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_fgets_or_die(data, data_size, fp);

Parameters:

data	The data, exactly as to be passed to the fgets(3) system call.
data_size	The data_size, exactly as to be passed to the fgets(3) system call.
fp	The fp, exactly as to be passed to the fgets(3) system call.

Returns:

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

Definition at line 46 of file fgets_or_die.c.