blob: c6d3e862231310dd023cfe357629d51f84256dba [file] [log] [blame]
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<!-- This is broken by doc revisioning.
-->
<link rel="shortcut icon" href="../../../../../img/favicon.ico">
<title>fs_rename - Apache Mynewt</title>
<link href="../../../../../css/bootstrap-3.0.3.min.css" rel="stylesheet">
<link rel="stylesheet" href="../../../../../css/highlight.css">
<link href="../../../../../css/base.css" rel="stylesheet">
<link href="../../../../../css/custom.css" rel="stylesheet">
<link href="../../../../../css/v2.css" rel="stylesheet">
<link href="https://fonts.googleapis.com/css?family=Lato" rel="stylesheet">
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css">
<!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
<script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js"></script>
<![endif]-->
<script>
(function(i, s, o, g, r, a, m) {
i["GoogleAnalyticsObject"] = r;
(i[r] =
i[r] ||
function() {
(i[r].q = i[r].q || []).push(arguments);
}),
(i[r].l = 1 * new Date());
(a = s.createElement(o)), (m = s.getElementsByTagName(o)[0]);
a.async = 1;
a.src = g;
m.parentNode.insertBefore(a, m);
})(window, document, "script", "//www.google-analytics.com/analytics.js", "ga");
ga("create", "UA-72162311-1", "auto");
ga("send", "pageview");
</script>
</head>
<body class="fs_rename">
<div class="container">
<div class="row v2-main-banner">
<a class="logo-cell" href="/">
<img class="logo" src="/img/logo.png">
</a>
<div class="tagline-cell">
<h4 class="tagline">An OS to build, deploy and securely manage billions of devices</h4>
</div>
<div class="news-cell">
<div class="well">
<h4>Latest News:</h4> <a href="/download">Apache Mynewt 1.11.0, Apache NimBLE 1.6.0 </a> released (September 7, 2023)
</div>
</div>
</div>
</div>
<nav id="navbar" class="navbar navbar-inverse affix-top" data-spy="affix" data-offset-top="150" role="navigation">
<div class="container">
<!-- Collapsed navigation -->
<div class="navbar-header">
<!-- Expander button -->
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
</div>
<!-- Expanded navigation -->
<div class="navbar-collapse collapse">
<!-- Main navigation -->
<ul class="nav navbar-nav navbar-right">
<li
class=""
>
<a href="/"><i class="fa fa-home" style="font-size: larger;"></i></a>
</li>
<li
class="important"
>
<a href="/quick-start/">Quick Start</a>
</li>
<li
class=""
>
<a href="/about/">About</a>
</li>
<li
class=""
>
<a href="/talks/">Talks</a>
</li>
<li
class="active"
>
<a href="/documentation/">Documentation</a>
</li>
<li
class=""
>
<a href="/download/">Download</a>
</li>
<li
class=""
>
<a href="/community/">Community</a>
</li>
<li
class=""
>
<a href="/events/">Events</a>
</li>
</ul>
</div>
</div>
</nav>
<div class="container">
<div class="row">
<div class="col-md-3 v2-sidebar sidebar-container"><div id="docSidebar" class="hidden-print" role="complementary">
<div class="top">
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../../../search.html" method="get">
<div class="form-group">
<input type="text" name="q" class="form-control" placeholder="Search documentation" />
</div>
</form>
</div>
</div>
<ul class="toc-nav">
<li class="doc-version"><select class="form-control" onchange="if (this.value) window.location.href=this.value">
<option value="/latest">
Version: master
</option>
<option value="/v1_11_0/" >
Version: 1.11.0
</option>
<option value="/v1_10_0/" >
Version: 1.10.0
</option>
<option value="/v1_9_0/" >
Version: 1.9.0
</option>
<option value="/v1_8_0/" >
Version: 1.8.0
</option>
<option value="/v1_7_0/" >
Version: 1.7.0
</option>
<option value="/v1_6_0/" >
Version: 1.6.0
</option>
<option value="/v1_5_0/" >
Version: 1.5.0
</option>
<option value="/v1_4_0/" >
Version: 1.4.0
</option>
<option value="/v1_3_0/os/introduction" selected="selected" >
Version: 1.3.0
</option>
<option value="/v1_2_0/os/introduction" >
Version: 1.2.0
</option>
<option value="/v1_1_0/os/introduction" >
Version: 1.1.0
</option>
<option value="/v1_0_0/os/introduction" >
Version: 1.0.0
</option>
<option value="/v0_9_0/os/introduction" >
Version: 0.9.0
</option>
</select></li>
<li ><a href="../../../../introduction/">Mynewt Documentation</a>
<ul>
<li ><a href="../../../../get_started/get_started/">Basic Setup</a>
</li>
<li >
<a href="../../../../get_started/vocabulary/">Concepts</a>
</li>
<li ><a href="../../../../tutorials/tutorials/">Tutorials</a>
</li>
<li ><a href="../../../../os_user_guide/">OS User Guide</a>
<ul>
<li ><a href="../../../../core_os/mynewt_os/">OS Core</a>
</li>
<li ><a href="../../../../core_os/porting/port_os/">Porting to your Platform</a>
</li>
<li ><a href="../../../console/console/">Console</a>
</li>
<li ><a href="../../../shell/shell/">Shell</a>
</li>
<li ><a href="../../../split/split/">Split Images</a>
</li>
<li ><a href="../../../bootloader/bootloader/">Bootloader</a>
</li>
<li><a href="
../fs/
">File System</a>
<ul>
<li ><a href="../fs/">File System Abstraction</a>
<ul>
<li >
<a href="../fs_return_codes/">Return Codes</a>
</li>
<li><a href="
../fs_ops/
">Data Structures</a>
</li>
<li><a href="
../fs_close/
">Functions</a>
<ul>
<li >
<a href="../fs_close/">fs_close</a>
</li>
<li >
<a href="../fs_closedir/">fs_closedir</a>
</li>
<li >
<a href="../fs_dirent_is_dir/">fs_dirent_is_dir</a>
</li>
<li >
<a href="../fs_dirent_name/">fs_dirent_name</a>
</li>
<li >
<a href="../fs_filelen/">fs_filelen</a>
</li>
<li >
<a href="../fs_getpos/">fs_getpos</a>
</li>
<li >
<a href="../fs_mkdir/">fs_mkdir</a>
</li>
<li >
<a href="../fs_open/">fs_open</a>
</li>
<li >
<a href="../fs_opendir/">fs_opendir</a>
</li>
<li >
<a href="../fs_read/">fs_read</a>
</li>
<li >
<a href="../fs_readdir/">fs_readdir</a>
</li>
<li >
<a href="../fs_register/">fs_register</a>
</li>
<li class="active">
<a href="./">fs_rename</a>
</li>
<li >
<a href="../fs_seek/">fs_seek</a>
</li>
<li >
<a href="../fs_unlink/">fs_unlink</a>
</li>
<li >
<a href="../fs_write/">fs_write</a>
</li>
<li >
<a href="../fsutil_read_file/">fsutil_read_file</a>
</li>
<li >
<a href="../fsutil_write_file/">fsutil_write_file</a>
</li>
</ul>
</li>
</ul>
</li>
<li >
<a href="../../fatfs/">FAT File System</a>
</li>
<li ><a href="../../nffs/nffs/">Newtron Flash File System</a>
</li>
<li >
<a href="../../otherfs/">Other File Systems</a>
</li>
</ul>
</li>
<li ><a href="../../../hal/hal/">Hardware Abstraction Layer</a>
</li>
<li ><a href="../../../sensor_framework/sensor_framework_overview/">Sensor Framework</a>
</li>
<li ><a href="../../../drivers/driver/">Drivers</a>
</li>
<li ><a href="../../../testutil/testutil/">Test Utilities</a>
</li>
<li ><a href="../../../devmgmt/newtmgr/">Device Management with Newt Manager</a>
</li>
<li ><a href="../../../imgmgr/imgmgr/">Image Manager</a>
</li>
<li >
<a href="../../../baselibc/">Baselibc library</a>
</li>
<li ><a href="../../../json/json/">JSON</a>
</li>
<li ><a href="../../../fcb/fcb/">Flash Circular Buffer</a>
</li>
<li ><a href="../../../stats/stats/">Stats</a>
</li>
<li ><a href="../../../logs/logs/">Logs</a>
</li>
<li ><a href="../../../sysinitconfig/sysinitconfig/">System Configuration And Initialization</a>
</li>
</ul>
</li>
<li><a href="
../../../../../network/ble/ble_intro/
">BLE User Guide</a>
</li>
<li ><a href="../../../../../newt/newt_intro/">Newt Tool Guide</a>
</li>
<li ><a href="../../../../../newtmgr/overview/">Newt Manager Guide</a>
</li>
<li >
<a href="../../../../../known_issues/">Known Issues</a>
</li>
</ul>
</li>
<li><a href="
../../../../../newt/install/prev_releases/
">Appendix</a>
</li>
</ul>
</div></div>
<div class="col-md-9" role="main">
<div class="doc-header">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="/documentation/">Docs</a></li>
<li>&raquo; <a href="os/modules/fs/fs/fs_close/">Functions</a></li>
<li>&raquo; <a href="os/modules/fs/fs/fs/">File System Abstraction</a></li>
<li>&raquo; File System</li>
<li>&raquo; <a href="os/os_user_guide/">OS User Guide</a></li>
<li>&raquo; <a href="os/introduction/">Mynewt Documentation</a></li>
<li>&raquo; fs_rename</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/apache/mynewt-site/blob/master/docs/os/modules/fs/fs/fs_rename.md"
class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
</div>
</div>
<div class="alert alert-warning">
<p>
Version 1.3.0 is not the most recent version of the Apache Mynewt
documentation. Click <a href="/latest">here</a> to read the latest
version.
</p>
</div>
<h2 id="fs_rename"><font color="#F2853F" style="font-size:24pt">fs_rename</font></h2>
<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code><span style="color: #A90D91">int</span> <span style="color: #000000">fs_rename</span>(<span style="color: #A90D91">const</span> <span style="color: #A90D91">char</span> <span style="color: #000000">*from</span>, <span style="color: #A90D91">const</span> <span style="color: #A90D91">char</span> <span style="color: #000000">*to</span>)
</code></pre></div>
<p>Performs a rename and / or move of the specified source path to the specified destination. The source path can refer to a file or a directory.</p>
<h4 id="arguments">Arguments</h4>
<table>
<thead>
<tr>
<th><em>Argument</em></th>
<th><em>Description</em></th>
</tr>
</thead>
<tbody>
<tr>
<td>from</td>
<td>The source path</td>
</tr>
<tr>
<td>to</td>
<td>The destination path</td>
</tr>
</tbody>
</table>
<h4 id="returned-values">Returned values</h4>
<ul>
<li>0 on success</li>
<li><a href="../fs_return_codes/">FS error code</a> on failure</li>
</ul>
<h4 id="notes">Notes</h4>
<p>The source path can refer to either a file or a directory. All intermediate directories in the destination path must already exist. If the source path refers to a file, the destination path must contain a full filename path, rather than just the new parent directory. If an object already exists at the specified destination path, this function causes it to be unlinked prior to the rename (i.e., the destination gets clobbered).</p>
<h4 id="header-file">Header file</h4>
<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code><span style="color: #633820">#include</span> <span style="color: #177500">&quot;fs/fs.h&quot;</span>
</code></pre></div>
<h4 id="example">Example</h4>
<p>This example demonstrates how to use fs_rename() to perform a log rotation. In this example, there is one primary log and three archived logs. <code>FS_ENOENT</code> errors returned by <code>fs_rename()</code> are ignored; it is not an error if an archived log was never created.</p>
<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code><span style="color: #A90D91">int</span>
<span style="color: #000000">rotate_logs</span>(<span style="color: #A90D91">void</span>)
{
<span style="color: #A90D91">struct</span> <span style="color: #3F6E75">fs_file</span> <span style="color: #000000">*file</span>;
<span style="color: #A90D91">int</span> <span style="color: #000000">rc</span>;
<span style="color: #177500">/* Rotate each of the log files. */</span>
<span style="color: #000000">rc</span> <span style="color: #000000">=</span> <span style="color: #000000">fs_rename</span>(<span style="color: #C41A16">&quot;/var/log/messages.2&quot;</span>, <span style="color: #C41A16">&quot;/var/log/messages.3&quot;</span>)
<span style="color: #A90D91">if</span> (<span style="color: #000000">rc</span> <span style="color: #000000">!=</span> <span style="color: #1C01CE">0</span> <span style="color: #000000">&amp;&amp;</span> <span style="color: #000000">rc</span> <span style="color: #000000">!=</span> <span style="color: #000000">FS_ENOENT</span>) <span style="color: #A90D91">return</span> <span style="color: #1C01CE">-1</span>;
<span style="color: #000000">rc</span> <span style="color: #000000">=</span> <span style="color: #000000">fs_rename</span>(<span style="color: #C41A16">&quot;/var/log/messages.1&quot;</span>, <span style="color: #C41A16">&quot;/var/log/messages.2&quot;</span>)
<span style="color: #A90D91">if</span> (<span style="color: #000000">rc</span> <span style="color: #000000">!=</span> <span style="color: #1C01CE">0</span> <span style="color: #000000">&amp;&amp;</span> <span style="color: #000000">rc</span> <span style="color: #000000">!=</span> <span style="color: #000000">FS_ENOENT</span>) <span style="color: #A90D91">return</span> <span style="color: #1C01CE">-1</span>;
<span style="color: #000000">rc</span> <span style="color: #000000">=</span> <span style="color: #000000">fs_rename</span>(<span style="color: #C41A16">&quot;/var/log/messages.0&quot;</span>, <span style="color: #C41A16">&quot;/var/log/messages.1&quot;</span>)
<span style="color: #A90D91">if</span> (<span style="color: #000000">rc</span> <span style="color: #000000">!=</span> <span style="color: #1C01CE">0</span> <span style="color: #000000">&amp;&amp;</span> <span style="color: #000000">rc</span> <span style="color: #000000">!=</span> <span style="color: #000000">FS_ENOENT</span>) <span style="color: #A90D91">return</span> <span style="color: #1C01CE">-1</span>;
<span style="color: #000000">rc</span> <span style="color: #000000">=</span> <span style="color: #000000">fs_rename</span>(<span style="color: #C41A16">&quot;/var/log/messages&quot;</span>, <span style="color: #C41A16">&quot;/var/log/messages.0&quot;</span>)
<span style="color: #A90D91">if</span> (<span style="color: #000000">rc</span> <span style="color: #000000">!=</span> <span style="color: #1C01CE">0</span> <span style="color: #000000">&amp;&amp;</span> <span style="color: #000000">rc</span> <span style="color: #000000">!=</span> <span style="color: #000000">FS_ENOENT</span>) <span style="color: #A90D91">return</span> <span style="color: #1C01CE">-1</span>;
<span style="color: #177500">/* Now create the new log file. */</span>
<span style="color: #000000">rc</span> <span style="color: #000000">=</span> <span style="color: #000000">fs_open</span>(<span style="color: #C41A16">&quot;/var/log/messages&quot;</span>, <span style="color: #000000">FS_ACCESS_WRITE</span> <span style="color: #000000">|</span> <span style="color: #000000">FS_ACCESS_TRUNCATE</span>,
<span style="color: #000000">&amp;file</span>);
<span style="color: #A90D91">if</span> (<span style="color: #000000">rc</span> <span style="color: #000000">!=</span> <span style="color: #1C01CE">0</span>) <span style="color: #A90D91">return</span> <span style="color: #1C01CE">-1</span>;
<span style="color: #000000">rc</span> <span style="color: #000000">=</span> <span style="color: #000000">fs_write</span>(<span style="color: #000000">file</span>, <span style="color: #C41A16">&quot;Creating new log file.\n&quot;</span>, <span style="color: #1C01CE">23</span>);
<span style="color: #000000">fs_close</span>(<span style="color: #000000">file</span>);
<span style="color: #A90D91">return</span> <span style="color: #000000">rc</span> <span style="color: #000000">==</span> <span style="color: #1C01CE">0</span> <span style="color: #000000">?</span> <span style="color: #1C01CE">0</span> <span style="color: #000000">:</span> <span style="color: #1C01CE">-1</span>;
}
</code></pre></div>
<div class="row">
<ul class="nav nav-pills" style="margin-bottom: 10px">
<li>
</li>
<li class="pull-right">
</li>
</ul>
</div>
<footer class="row">
<div class="col-xs-12">
<p class="copyright">Apache Mynewt is available under Apache License, version 2.0.</p>
</div>
<div class="col-xs-12">
<div class="logos">
<a href="https://www.apache.org/">
<img src="/img/asf_logo_wide_small.png" alt="Apache" title="Apache">
</a>
<p>
Copyright © 2015-2021 The Apache Software Foundation.<br>
<small class="footnote">
Apache Mynewt, Mynewt, Apache, the Apache feather logo, and the Apache Mynewt
project logo are either registered trademarks or trademarks of the Apache
Software Foundation in the United States and other countries.
</small>
</p>
<a href="">
<img src="https://www.countit.com/images/add_to_slack.png" alt="Slack Icon" title="Join our Slack Community" />
</a>
</div>
</div>
<a href="https://www.apache.org/licenses/">
<button class="button-footer-asf">
License
</button>
</a>
<a href="https://www.apache.org/foundation/sponsorship.html">
<button class="button-footer-asf">
Sponsorship
</button>
</a>
<a href="https://www.apache.org/foundation/thanks.html">
<button class="button-footer-asf">
Thanks
</button>
</a>
<a href="https://www.apache.org/security/">
<button class="button-footer-asf">
Security
</button>
</a>
<a href="https://apache.org/events/current-event">
<button class="button-footer-asf">
ASF Events
</button>
</a>
</footer>
</div>
</div>
</div>
<script src="../../../../../js/jquery-1.10.2.min.js"></script>
<script src="../../../../../js/bootstrap-3.0.3.min.js"></script>
<script src="../../../../../js/highlight.pack.js"></script>
<script src="../../../../../js/base.js"></script>
<script src="../../../../../js/custom.js"></script>
<script src="search/main.js"></script>
</body>
</html>