libexplain/fdopendir_or_die.c File Reference

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

Go to the source code of this file.

Functions
static DIR *	fdopendir (int fildes)
DIR *	explain_fdopendir_on_error (int fildes)
DIR *	explain_fdopendir_or_die (int fildes)

---

Function Documentation

DIR* explain_fdopendir_on_error

(

int

fildes

)

The explain_fdopendir_on_error function is used to call the fdopendir(3) system call. On failure an explanation will be printed to stderr, obtained from the explain_fdopendir(3) function.

Parameters:

fildes

The fildes, exactly as to be passed to the fdopendir(3) system call.

Returns:

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

Example:

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

 DIR *result = explain_fdopendir_on_error(fildes);
 if (!result)
 {
     ...cope with error
     ...no need to print error message
 }

Definition at line 40 of file fdopendir_or_die.c.

DIR* explain_fdopendir_or_die

(

int

fildes

)

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

Parameters:

fildes

The fildes, exactly as to be passed to the fdopendir(3) system call.

Returns:

This function only returns on success, see fdopendir(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:

 DIR *result = explain_fdopendir_or_die(fildes);

Definition at line 59 of file fdopendir_or_die.c.

static DIR* fdopendir

(

int

fildes

)

[static]

Definition at line 29 of file fdopendir_or_die.c.