libexplain/readdir_on_error.c File Reference

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

Go to the source code of this file.

Functions
struct dirent *	explain_readdir_on_error (DIR *dir)

---

Function Documentation

struct dirent* explain_readdir_on_error

(

DIR *

dir

)

[read]

The explain_readdir_on_error function is used to call the readdir(2) system call. On failure an explanation will be printed to stderr, obtained from the explain_readdir(3) function.

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

 errno = 0;
 struct dirent *result = explain_readdir_on_error(dir);
 if (!result && errno)
 {
     ...cope with error
     ...no need to print error message
 }

Parameters:

dir	The dir, exactly as to be passed to the readdir(2) system call.

Returns:

The value returned by the wrapped readdir(2) system call.

Definition at line 27 of file readdir_on_error.c.