libexplain/remove_on_error.c File Reference

#include <libexplain/ac/errno.h>
#include <libexplain/ac/stdio.h>
#include <libexplain/remove.h>
#include <libexplain/output.h>

Go to the source code of this file.

Functions
static int	remove (const char *pathname)
int	explain_remove_on_error (const char *pathname)

---

Function Documentation

int explain_remove_on_error

(

const char *

pathname

)

The explain_remove_on_error function is used to call the remove(3) system call. On failure an explanation will be printed to stderr, obtained from the explain_remove(3) function.

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

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

Parameters:

pathname

The pathname, exactly as to be passed to the remove(3) system call.

Returns:

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

Definition at line 43 of file remove_on_error.c.

static int remove

(

const char *

pathname

)

[static]

Definition at line 29 of file remove_on_error.c.