std::rename
From cppreference.com
C++
Feature test macros (C++20)
Concepts library (C++20)
Metaprogramming library (C++11)
Ranges library (C++20)
Filesystem library (C++17)
Concurrency support library (C++11)
Execution control library (C++26)
Input/output library
Print functions (C++23)
Buffers
(C++23)
(C++98/26*)
(C++20)
Streams
Abstractions
File I/O
String I/O
Array I/O
(C++23)
(C++23)
(C++23)
(C++98/26*)
(C++98/26*)
(C++98/26*)
Synchronized Output
(C++20)
Types
Error category interface
(C++11)
(C++11)
C-style I/O
Types and objects
Functions
File access
Direct input/output
Unformatted input/output
Formatted input
(C++11)(C++11)(C++11)
(C++11)(C++11)(C++11)
Formatted output
(C++11)
(C++11)
File positioning
Error handling
Operations on files
rename
Defined in header
<cstdio>
int rename( const char* old_filename, const char* new_filename );
Changes the filename of a file. The file is identified by character string pointed to by old_filename. The new filename is identified by character string pointed to by new_filename.
If new_filename exists, the behavior is implementation-defined.
Contents
[edit] Parameters
old_filename
-
pointer to a null-terminated string containing the path identifying the file to rename
new_filename
-
pointer to a null-terminated string containing the new path of the file
[edit] Return value
0 upon success or non-zero value on error.
[edit] Notes
POSIX specifies many additional details on the semantics of this function, which are reproduced in C++ by std::filesystem::rename .
[edit] Example
Run this code
#include <cstdio> #include <cstdlib> #include <fstream> #include <iostream> int main() { if (!std::ofstream ("from.txt").put('a')) // create and write to file { std::perror ("Error creating from.txt"); return EXIT_FAILURE ; } if (std::rename("from.txt", "to.txt")) { std::perror ("Error renaming"); return EXIT_FAILURE ; } std::cout << std::ifstream ("to.txt").rdbuf() << '\n'; // print file return EXIT_SUCCESS ; }
Output:
a
[edit] See also
C documentation for rename