| MG Mud User | 88f1247 | 2016-06-24 23:31:02 +0200 | [diff] [blame] | 1 | SYNOPSIS |
| Zesstra | d59c389 | 2019-11-28 20:53:39 +0100 | [diff] [blame] | 2 | int rename(string from, string to) |
| MG Mud User | 88f1247 | 2016-06-24 23:31:02 +0200 | [diff] [blame] | 3 | |
| Zesstra | 715ec20 | 2025-07-09 22:18:31 +0200 | [diff] [blame^] | 4 | DESCRIPTION |
| MG Mud User | 88f1247 | 2016-06-24 23:31:02 +0200 | [diff] [blame] | 5 | |
| Zesstra | 715ec20 | 2025-07-09 22:18:31 +0200 | [diff] [blame^] | 6 | The efun rename() will move from to the new name to. If from |
| 7 | is a file, then to may be either a file or a directory. If |
| 8 | from is a directory, then to has to be a directory. If to |
| 9 | exists and is a directory, then from will be placed in that |
| 10 | directory and keep its original name. |
| MG Mud User | 88f1247 | 2016-06-24 23:31:02 +0200 | [diff] [blame] | 11 | |
| Zesstra | 715ec20 | 2025-07-09 22:18:31 +0200 | [diff] [blame^] | 12 | You must have write permission for from to rename the file. |
| MG Mud User | 88f1247 | 2016-06-24 23:31:02 +0200 | [diff] [blame] | 13 | |
| Zesstra | 715ec20 | 2025-07-09 22:18:31 +0200 | [diff] [blame^] | 14 | It is only possible to change name of a directory within a |
| 15 | directory on machines running System V, i.e. it is not |
| 16 | possible to move to another directory. It is not possible to |
| 17 | move a directory across filesystems on any system. |
| MG Mud User | 88f1247 | 2016-06-24 23:31:02 +0200 | [diff] [blame] | 18 | |
| Zesstra | 715ec20 | 2025-07-09 22:18:31 +0200 | [diff] [blame^] | 19 | On successfull completion rename() will return 0. If any error |
| 20 | occurs, a non-zero value is returned. |
| 21 | |
| 22 | EXAMPLES |
| MG Mud User | 88f1247 | 2016-06-24 23:31:02 +0200 | [diff] [blame] | 23 | rename("/players/wizard/obj.c", "/players/wizard/newobj.c"); |
| 24 | |
| Zesstra | 715ec20 | 2025-07-09 22:18:31 +0200 | [diff] [blame^] | 25 | SEE ALSO |
| MG Mud User | 88f1247 | 2016-06-24 23:31:02 +0200 | [diff] [blame] | 26 | copy_file(E), mkdir(E), rmdir(E), rm(E) |