1explain_rename_or_die(3) Library Functions Manual explain_rename_or_die(3)
2
3
4
6 explain_rename_or_die - change the name of a file and report errors
7
9 #include <libexplain/rename.h>
10 void explain_rename_or_die(const char *oldpath, const char *newpath);
11
13 The explain_rename_or_die function is used to call the rename(2) system
14 call. On failure an explanation will be printed to stderr, obtained
15 from explain_rename(3), and then the process terminates by calling
16 exit(EXIT_FAILURE).
17
18 This function is intended to be used in a fashion similar to the fol‐
19 lowing example:
20 explain_rename_or_die(oldpath, newpath);
21
22 oldpath The oldpath, exactly as to be passed to the rename(2) system
23 call.
24
25 newpath The newpath, exactly as to be passed to the rename(2) system
26 call.
27
28 Returns:
29 This function only returns on success. On failure, prints an
30 explanation and exits.
31
33 rename(2)
34 change the name or location of a file
35
36 explain_rename(3)
37 explain rename(2) errors
38
39 exit(2) terminate the calling process
40
42 libexplain version 1.4
43 Copyright (C) 2008 Peter Miller
44
45
46
47 explain_rename_or_die(3)