libexplain/rename_or_die.c File Reference

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

Go to the source code of this file.

Functions
void	explain_rename_or_die (const char *oldpath, const char *newpath)

---

Function Documentation

void explain_rename_or_die	(	const char *	oldpath,
		const char *	newpath
	)

The explain_rename_or_die function is used to call the rename(2) system call. On failure an explanation will be printed to stderr, obtained from the explain_rename(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_rename_or_die(oldpath, newpath);

Parameters:

oldpath	The oldpath, exactly as to be passed to the rename(2) system call.
newpath	The newpath, exactly as to be passed to the rename(2) system call.

Returns:

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

Definition at line 25 of file rename_or_die.c.