128 lines
12 KiB
HTML
128 lines
12 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="zh" dir="ltr" class="client-nojs" xmlns="http://www.w3.org/1999/xhtml" xml:lang="zh">
|
|
<head><meta http-equiv="x-ua-compatible" content="ie=edge">
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
<title>std::filesystem::remove, std::filesystem::remove_all</title>
|
|
<link rel="stylesheet" href="ext.css" />
|
|
<link rel="stylesheet" href="site_modules.css" />
|
|
</head>
|
|
<body class="mediawiki ltr sitedir-ltr ns-0 ns-subject page-cpp_filesystem_remove skin-cppreference2 action-view cpp-navbar">
|
|
<div id="cpp-content-base">
|
|
<div id="content"><a id="top"></a>
|
|
<h1 id="firstHeading" class="firstHeading"><span style="font-size:0.7em; line-height:130%">std::filesystem::</span>remove, <span style="font-size:0.7em; line-height:130%">std::filesystem::</span>remove_all</h1>
|
|
<div id="bodyContent">
|
|
<div id="contentSub"><span class="subpages">< <a href="cpp.html">cpp</a>‎ | <a href="cpp-filesystem.html">filesystem</a></span></div>
|
|
<div id="mw-content-text" lang="zh" dir="ltr" class="mw-content-ltr" xml:lang="zh">
|
|
<table class="t-dcl-begin">
|
|
<tbody>
|
|
<tr class="t-dsc-header">
|
|
<td>
|
|
<div>定义于头文件 <code><a href="cpp-header-filesystem.html"><filesystem></a></code></div>
|
|
</td>
|
|
<td></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr class="t-dcl t-since-cxx17">
|
|
<td>
|
|
<div><span class="mw-geshi cpp source-cpp"><span class="kw4">bool</span> remove<span class="br0">(</span><span class="kw4">const</span> <a href="cpp-filesystem-path.html"><span class="kw2199">std::<span class="me2">filesystem</span><span class="sy4">::</span><span class="me2">path</span></span></a><span class="sy3">&</span> p<span class="br0">)</span><span class="sy4">;</span><br />
|
|
<span class="kw4">bool</span> remove<span class="br0">(</span><span class="kw4">const</span> <a href="cpp-filesystem-path.html"><span class="kw2199">std::<span class="me2">filesystem</span><span class="sy4">::</span><span class="me2">path</span></span></a><span class="sy3">&</span> p, <a href="cpp-error-error_code.html"><span class="kw877">std::<span class="me2">error_code</span></span></a><span class="sy3">&</span> ec<span class="br0">)</span> <span class="kw1">noexcept</span><span class="sy4">;</span></span></div>
|
|
</td>
|
|
<td>(1)</td>
|
|
<td><span class="t-mark-rev t-since-cxx17">(C++17 起)</span></td>
|
|
</tr>
|
|
<tr class="t-dcl t-since-cxx17">
|
|
<td>
|
|
<div><span class="mw-geshi cpp source-cpp"><a href="cpp-types-integer.html"><span class="kw132">std::<span class="me2">uintmax_t</span></span></a> remove_all<span class="br0">(</span><span class="kw4">const</span> <a href="cpp-filesystem-path.html"><span class="kw2199">std::<span class="me2">filesystem</span><span class="sy4">::</span><span class="me2">path</span></span></a><span class="sy3">&</span> p<span class="br0">)</span><span class="sy4">;</span><br />
|
|
<a href="cpp-types-integer.html"><span class="kw132">std::<span class="me2">uintmax_t</span></span></a> remove_all<span class="br0">(</span><span class="kw4">const</span> <a href="cpp-filesystem-path.html"><span class="kw2199">std::<span class="me2">filesystem</span><span class="sy4">::</span><span class="me2">path</span></span></a><span class="sy3">&</span> p, <a href="cpp-error-error_code.html"><span class="kw877">std::<span class="me2">error_code</span></span></a><span class="sy3">&</span> ec<span class="br0">)</span><span class="sy4">;</span></span></div>
|
|
</td>
|
|
<td>(2)</td>
|
|
<td><span class="t-mark-rev t-since-cxx17">(C++17 起)</span></td>
|
|
</tr>
|
|
<tr class="t-dcl-sep">
|
|
<td></td>
|
|
<td></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<div class="t-li1"><span class="t-li">1)</span> 删除路径 <code>p</code> 所标识的文件或空目录，如同用 POSIX <a rel="nofollow" class="external text" href="http://pubs.opengroup.org/onlinepubs/9699919799/functions/remove.html">remove</a> 。不跟随符号链接（移除符号链接，而非其目标）</div>
|
|
<div class="t-li1"><span class="t-li">2)</span> 递归地删除 <code>p</code> 的内容（若它是目录）及其所有子目录的内容，然后删除 <code>p</code> 自身，如同重复应用 POSIX <a rel="nofollow" class="external text" href="http://pubs.opengroup.org/onlinepubs/9699919799/functions/remove.html">remove</a> 。不跟随符号链接（移除符号链接，而非其目标）</div>
|
|
<h3><span class="mw-headline" id=".E5.8F.82.E6.95.B0">参数</span></h3>
|
|
<table class="t-par-begin">
|
|
<tr class="t-par">
|
|
<td>p</td>
|
|
<td>-</td>
|
|
<td>要删除的路径</td>
|
|
</tr>
|
|
<tr class="t-par">
|
|
<td>ec</td>
|
|
<td>-</td>
|
|
<td>不抛出重载中报告错误的输出参数</td>
|
|
</tr>
|
|
</table>
|
|
<h3><span class="mw-headline" id=".E8.BF.94.E5.9B.9E.E5.80.BC">返回值</span></h3>
|
|
<div class="t-li1"><span class="t-li">1)</span> 若文件被删除则为 <span class="t-c"><span class="mw-geshi cpp source-cpp"><span class="kw2">true</span></span></span> ，若文件不存在则为 <span class="t-c"><span class="mw-geshi cpp source-cpp"><span class="kw2">false</span></span></span> 。接受 <code>error_code&</code> 参数的重载在错误时返回 <span class="t-c"><span class="mw-geshi cpp source-cpp"><span class="kw2">false</span></span></span> 。</div>
|
|
<div class="t-li1"><span class="t-li">2)</span> 返回被删除的文件及目录数量（可以是零，若用以起始的 <code>p</code> 不存在）。接受 <code>error_code&</code> 参数的重载在错误时返回 <span class="t-c"><span class="mw-geshi cpp source-cpp"><span class="kw1">static_cast</span><span class="sy1"><</span><a href="cpp-types-integer.html"><span class="kw132">std::<span class="me2">uintmax_t</span></span></a><span class="sy1">></span><span class="br0">(</span><span class="sy2">-</span><span class="nu0">1</span><span class="br0">)</span></span></span> 。</div>
|
|
<h3><span class="mw-headline" id=".E5.BC.82.E5.B8.B8">异常</span></h3>
|
|
<p>不接受 <span class="t-c"><span class="mw-geshi cpp source-cpp"><a href="cpp-error-error_code.html"><span class="kw877">std::<span class="me2">error_code</span></span></a><span class="sy3">&</span></span></span> 参数的重载在底层 OS API 错误时抛出 <a href="cpp-filesystem-filesystem_error.html"><tt>filesystem_error</tt></a> ，以第一 path 参数 <code>p</code> 和作为错误码参数的 OS 错误码构造。若 OS API 调用失败，则接受 <span class="t-c"><span class="mw-geshi cpp source-cpp"><a href="cpp-error-error_code.html"><span class="kw877">std::<span class="me2">error_code</span></span></a><span class="sy3">&</span></span></span> 参数的重载设置该参数为 OS API 错误码，而若不出现错误则执行 <span class="t-c"><span class="mw-geshi cpp source-cpp">ec.<span class="me1">clear</span><span class="br0">(</span><span class="br0">)</span></span></span> 。若内存分配失败，则任何不标记为 <code>noexcept</code> 的重载可能抛出 <span class="t-lc"><a href="cpp-memory-new-bad_alloc.html">std::bad_alloc</a></span> 。</p>
|
|
<h3><span class="mw-headline" id=".E6.B3.A8.E6.84.8F">注意</span></h3>
|
|
<p>在 POSIX 系统上，此函数通常按需调用 <code>unlink</code> 和 <code>rmdir</code> ，在 Windows 上则是 <code>RemoveDirectoryW</code> 和 <code>DeleteFileW</code> 。</p>
|
|
<h3><span class="mw-headline" id=".E7.BC.BA.E9.99.B7.E6.8A.A5.E5.91.8A">缺陷报告</span></h3>
|
|
<p>下列更改行为的缺陷报告追溯地应用于以前出版的 C++ 标准。</p>
|
|
<table class="dsctable" style="font-size:0.8em">
|
|
<tr>
|
|
<th>DR</th>
|
|
<th>应用于</th>
|
|
<th>出版时的行为</th>
|
|
<th>正确行为</th>
|
|
</tr>
|
|
<tr>
|
|
<td><a rel="nofollow" class="external text" href="https://cplusplus.github.io/LWG/issue3014">LWG 3014</a></td>
|
|
<td>C++17</td>
|
|
<td><code>remove_all</code> 的 <code>error_code</code> 重载被标记为 noexcept 但能分配内存</td>
|
|
<td>移除 noexcept</td>
|
|
</tr>
|
|
</table>
|
|
<h3><span class="mw-headline" id=".E7.A4.BA.E4.BE.8B">示例</span></h3>
|
|
<div class="t-example">
|
|
<div class="t-example-live-link"></div>
|
|
<div dir="ltr" class="mw-geshi" style="text-align: left;">
|
|
<div class="cpp source-cpp">
|
|
<pre class="de1"><span class="co2">#include <iostream></span>
|
|
<span class="co2">#include <cstdint></span>
|
|
<span class="co2">#include <filesystem></span>
|
|
<span class="kw1">namespace</span> fs <span class="sy1">=</span> std<span class="sy4">::</span><span class="me2">filesystem</span><span class="sy4">;</span>
|
|
<span class="kw4">int</span> main<span class="br0">(</span><span class="br0">)</span>
|
|
<span class="br0">{</span>
|
|
fs<span class="sy4">::</span><span class="me2">path</span> dir <span class="sy1">=</span> fs<span class="sy4">::</span><span class="me2">temp_directory_path</span><span class="br0">(</span><span class="br0">)</span><span class="sy4">;</span>
|
|
fs<span class="sy4">::</span><span class="me2">create_directories</span><span class="br0">(</span>dir <span class="sy2">/</span> <span class="st0">"abcdef/example"</span><span class="br0">)</span><span class="sy4">;</span>
|
|
<a href="cpp-types-integer.html"><span class="kw132">std::<span class="me2">uintmax_t</span></span></a> n <span class="sy1">=</span> fs<span class="sy4">::</span><span class="me2">remove_all</span><span class="br0">(</span>dir <span class="sy2">/</span> <span class="st0">"abcdef"</span><span class="br0">)</span><span class="sy4">;</span>
|
|
<a href="cpp-io-cout.html"><span class="kw1758">std::<span class="me2">cout</span></span></a> <span class="sy1"><<</span> <span class="st0">"Deleted "</span> <span class="sy1"><<</span> n <span class="sy1"><<</span> <span class="st0">" files or directories<span class="es1">\n</span>"</span><span class="sy4">;</span>
|
|
<span class="br0">}</span></pre></div>
|
|
</div>
|
|
<p>可能的输出：</p>
|
|
<div dir="ltr" class="mw-geshi" style="text-align: left;">
|
|
<div class="text source-text">
|
|
<pre class="de1">Deleted 2 files or directories</pre></div>
|
|
</div>
|
|
</div>
|
|
<h3><span class="mw-headline" id=".E5.8F.82.E9.98.85">参阅</span></h3>
|
|
<table class="t-dsc-begin">
|
|
<tr class="t-dsc">
|
|
<td>
|
|
<div class="t-dsc-member-div">
|
|
<div><a href="cpp-io-c-remove.html"><span class="t-lines"><span>remove</span></span></a></div>
|
|
</div>
|
|
</td>
|
|
<td>删除文件<br />
|
|
<span class="t-mark">(函数)</span></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="visualClear"></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|