libexplain/rmdir_on_error.c File Reference

#include <libexplain/ac/errno.h>
#include <libexplain/ac/unistd.h>
#include <libexplain/rmdir.h>
#include <libexplain/output.h>

Go to the source code of this file.

Functions
int	explain_rmdir_on_error (const char *pathname)

---

Function Documentation

int explain_rmdir_on_error

(

const char *

pathname

)

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

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

 if (explain_rmdir_on_error(pathname) < 0)
 {
     ...cope with error
     ...no need to print error message
 }

Parameters:

pathname

The pathname, exactly as to be passed to the rmdir(2) system call.

Returns:

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

Definition at line 27 of file rmdir_on_error.c.