libexplain/telldir_on_error.c File Reference

#include <libexplain/ac/dirent.h>
#include <libexplain/ac/errno.h>
#include <libexplain/telldir.h>
#include <libexplain/output.h>

Go to the source code of this file.

Functions
long	explain_telldir_on_error (DIR *dir)

---

Function Documentation

long explain_telldir_on_error

(

DIR *

dir

)

The explain_telldir_on_error function is used to call the telldir(3) system call. On failure an explanation will be printed to stderr, obtained from the explain_telldir(3) function.

Parameters:

dir	The dir, exactly as to be passed to the telldir(3) system call.

Returns:

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

Example:

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

 long result = explain_telldir_on_error(dir);
 if (result < 0)
 {
     ...cope with error
     ...no need to print error message
 }

Definition at line 27 of file telldir_on_error.c.