libexplain/unlink_or_die.c File Reference

#include <libexplain/output.h>
#include <libexplain/unlink.h>

Go to the source code of this file.

Functions
void	explain_unlink_or_die (const char *pathname)

---

Function Documentation

void explain_unlink_or_die

(

const char *

pathname

)

The explain_unlink_or_die function is used to call the unlink(2) system call. On failure an explanation will be printed to stderr, obtained from the explain_unlink(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:

 explain_unlink_or_die(pathname);

Parameters:

pathname

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

Returns:

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

Definition at line 24 of file unlink_or_die.c.