libexplain/fwrite_or_die.c File Reference

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

Go to the source code of this file.

Functions
size_t	explain_fwrite_on_error (const void *ptr, size_t size, size_t nmemb, FILE *fp)
size_t	explain_fwrite_or_die (const void *ptr, size_t size, size_t nmemb, FILE *fp)

---

Function Documentation

size_t explain_fwrite_on_error	(	const void *	ptr,
		size_t	size,
		size_t	nmemb,
		FILE *	fp
	)

The explain_fwrite_on_error function is used to call the fwrite(3) system call. On failure an explanation will be printed to stderr, obtained from the explain_fwrite(3) function.

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

 if (explain_fwrite_on_error(ptr, size, nmemb, fp) == 0)
 {
     ...cope with error
     ...no need to print error message
 }

Parameters:

ptr	The ptr, exactly as to be passed to the fwrite(3) system call.
size	The size, exactly as to be passed to the fwrite(3) system call.
nmemb	The nmemb, exactly as to be passed to the fwrite(3) system call.
fp	The fp, exactly as to be passed to the fwrite(3) system call.

Returns:

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

Definition at line 27 of file fwrite_or_die.c.

size_t explain_fwrite_or_die	(	const void *	ptr,
		size_t	size,
		size_t	nmemb,
		FILE *	fp
	)

The explain_fwrite_or_die function is used to call the fwrite(3) system call. On failure an explanation will be printed to stderr, obtained from the explain_fwrite(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_fwrite_or_die(ptr, size, nmemb, fp);

Parameters:

ptr	The ptr, exactly as to be passed to the fwrite(3) system call.
size	The size, exactly as to be passed to the fwrite(3) system call.
nmemb	The nmemb, exactly as to be passed to the fwrite(3) system call.
fp	The fp, exactly as to be passed to the fwrite(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 fwrite_or_die.c.