diff options
Diffstat (limited to 'devdocs/c/io%2Frename.html')
| -rw-r--r-- | devdocs/c/io%2Frename.html | 59 |
1 files changed, 59 insertions, 0 deletions
diff --git a/devdocs/c/io%2Frename.html b/devdocs/c/io%2Frename.html new file mode 100644 index 00000000..3997966b --- /dev/null +++ b/devdocs/c/io%2Frename.html @@ -0,0 +1,59 @@ + <h1 id="firstHeading" class="firstHeading">rename</h1> <table class="t-dcl-begin"> <tr class="t-dsc-header"> <th> Defined in header <code><stdio.h></code> </th> <th> </th> <th> </th> </tr> <tr class="t-dcl"> <td class="t-dcl-nopad"> <pre data-language="c">int rename( const char* old_filename, const char* new_filename );</pre> +</td> <td class="t-dcl-nopad"> </td> <td class="t-dcl-nopad"> </td> </tr> </table> <p>Changes the filename of a file. The file is identified by character string pointed to by <code>old_filename</code>. The new filename is identified by character string pointed to by <code>new_filename</code>.</p> +<p>If <code>new_filename</code> exists, the behavior is implementation-defined.</p> +<h3 id="Parameters"> Parameters</h3> <table class="t-par-begin"> <tr class="t-par"> <td> old_filename </td> <td> - </td> <td> pointer to a null-terminated string containing the path identifying the file to rename </td> +</tr> <tr class="t-par"> <td> new_filename </td> <td> - </td> <td> pointer to a null-terminated string containing the new path of the file </td> +</tr> +</table> <h3 id="Return_value"> Return value</h3> <p><code>0</code> upon success or non-zero value on error.</p> +<h3 id="Notes"> Notes</h3> <p><a rel="nofollow" class="external text" href="https://pubs.opengroup.org/onlinepubs/9699919799/functions/rename.html">POSIX</a> specifies many additional details on the semantics of this function.</p> +<h3 id="Example"> Example</h3> <div class="t-example"> <div class="c source-c"><pre data-language="c">#include <stdio.h> +#include <stdlib.h> + +int main(void) +{ + FILE* fp = fopen("from.txt", "w"); // create file "from.txt" + if (!fp) + { + perror("from.txt"); + return EXIT_FAILURE; + } + fputc('a', fp); // write to "from.txt" + fclose(fp); + + int rc = rename("from.txt", "to.txt"); + if (rc) + { + perror("rename"); + return EXIT_FAILURE; + } + + fp = fopen("to.txt", "r"); + if(!fp) + { + perror("to.txt"); + return EXIT_FAILURE; + } + printf("%c\n", fgetc(fp)); // read from "to.txt" + fclose(fp); + + return EXIT_SUCCESS; +}</pre></div> <p>Possible output:</p> +<div class="text source-text"><pre data-language="c">a</pre></div> </div> <h3 id="References"> References</h3> <ul> +<li> C23 standard (ISO/IEC 9899:2023): </li> +<ul><li> 7.21.4.2 The rename function (p: TBD) </li></ul> +<li> C17 standard (ISO/IEC 9899:2018): </li> +<ul><li> 7.21.4.2 The rename function (p: TBD) </li></ul> +<li> C11 standard (ISO/IEC 9899:2011): </li> +<ul><li> 7.21.4.2 The rename function (p: 302-303) </li></ul> +<li> C99 standard (ISO/IEC 9899:1999): </li> +<ul><li> 7.19.4.2 The rename function (p: 268-269) </li></ul> +<li> C89/C90 standard (ISO/IEC 9899:1990): </li> +<ul><li> 4.9.4.2 The rename function </li></ul> +</ul> <h3 id="See_also"> See also</h3> <table class="t-dsc-begin"> <tr class="t-dsc"> <td> <div><a href="remove" title="c/io/remove"> <span class="t-lines"><span>remove</span></span></a></div> </td> <td> erases a file <br> <span class="t-mark">(function)</span> </td> +</tr> <tr class="t-dsc"> <td colspan="2"> <span><a href="https://en.cppreference.com/w/cpp/io/c/rename" title="cpp/io/c/rename">C++ documentation</a></span> for <code>rename</code> </td> +</tr> </table> <div class="_attribution"> + <p class="_attribution-p"> + © cppreference.com<br>Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.<br> + <a href="https://en.cppreference.com/w/c/io/rename" class="_attribution-link">https://en.cppreference.com/w/c/io/rename</a> + </p> +</div> |