libexplain/readdir_or_die.c File Reference

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

Go to the source code of this file.

Functions
struct dirent *	explain_readdir_or_die (DIR *dir)

---

Function Documentation

struct dirent* explain_readdir_or_die

(

DIR *

dir

)

[read]

The explain_readdir_or_die 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, and then the process terminates by calling exit(EXIT_FAILURE).

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

 struct dirent *result = explain_readdir_or_die(dir);

Parameters:

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

Returns:

This function only returns on success. On failure, prints an explanation and exits, it does not return.

Definition at line 27 of file readdir_or_die.c.