libexplain/fgetpos_or_die.c File Reference

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

Go to the source code of this file.

Functions
int	explain_fgetpos_on_error (FILE *fp, fpos_t *pos)
void	explain_fgetpos_or_die (FILE *fp, fpos_t *pos)

---

Function Documentation

int explain_fgetpos_on_error	(	FILE *	fp,
		fpos_t *	pos
	)

The explain_fgetpos_on_error function is used to call the fgetpos(3) system call. On failure an explanation will be printed to stderr, obtained from the explain_fgetpos(3) function.

Parameters:

fp	The fp, exactly as to be passed to the fgetpos(3) system call.
pos	The pos, exactly as to be passed to the fgetpos(3) system call.

Returns:

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

Example:

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

 if (explain_fgetpos_on_error(fp, pos) < 0)
 {
     ...cope with error
     ...no need to print error message
 }

Definition at line 27 of file fgetpos_or_die.c.

void explain_fgetpos_or_die	(	FILE *	fp,
		fpos_t *	pos
	)

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

Parameters:

fp	The fp, exactly as to be passed to the fgetpos(3) system call.
pos	The pos, exactly as to be passed to the fgetpos(3) system call.

Returns:

This function only returns on success, see fgetpos(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_fgetpos_or_die(fp, pos);

Definition at line 46 of file fgetpos_or_die.c.