libexplain/fseek_or_die.c File Reference

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

Go to the source code of this file.

Functions
int	explain_fseek_on_error (FILE *fp, long offset, int whence)
void	explain_fseek_or_die (FILE *fp, long offset, int whence)

---

Function Documentation

int explain_fseek_on_error	(	FILE *	fp,
		long	offset,
		int	whence
	)

The explain_fseek_on_error function is used to call the fseek(3) system call. On failure an explanation will be printed to stderr, obtained from the explain_fseek(3) function.

Parameters:

fp	The fp, exactly as to be passed to the fseek(3) system call.
offset	The offset, exactly as to be passed to the fseek(3) system call.
whence	The whence, exactly as to be passed to the fseek(3) system call.

Returns:

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

Example:

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

 if (explain_fseek_on_error(fp, offset, whence) < 0)
 {
     ...cope with error
     ...no need to print error message
 }

Definition at line 27 of file fseek_or_die.c.

void explain_fseek_or_die	(	FILE *	fp,
		long	offset,
		int	whence
	)

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

Parameters:

fp	The fp, exactly as to be passed to the fseek(3) system call.
offset	The offset, exactly as to be passed to the fseek(3) system call.
whence	The whence, exactly as to be passed to the fseek(3) system call.

Returns:

This function only returns on success, see fseek(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_fseek_or_die(fp, offset, whence);

Definition at line 46 of file fseek_or_die.c.