libexplain/setvbuf_or_die.c File Reference

#include <libexplain/ac/stdio.h>
#include <libexplain/output.h>
#include <libexplain/setvbuf.h>

Go to the source code of this file.

Functions
void	explain_setvbuf_or_die (FILE *fp, char *data, int mode, size_t size)

---

Function Documentation

void explain_setvbuf_or_die	(	FILE *	fp,
		char *	data,
		int	mode,
		size_t	size
	)

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

Parameters:

fp	The fp, exactly as to be passed to the setvbuf(3) system call.
data	The data, exactly as to be passed to the setvbuf(3) system call.
mode	The mode, exactly as to be passed to the setvbuf(3) system call.
size	The size, exactly as to be passed to the setvbuf(3) system call.

Returns:

This function only returns on success, see setvbuf(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_setvbuf_or_die(fp, data, mode, size);

Definition at line 26 of file setvbuf_or_die.c.