Files
oldlinux-files/Ref-docs/POSIX/susv3/functions/remove.html
2024-02-19 00:21:47 -05:00

152 lines
5.4 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta name="generator" content="HTML Tidy, see www.w3.org">
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<link type="text/css" rel="stylesheet" href="style.css"><!-- Generated by The Open Group's rhtm tool v1.2.1 -->
<!-- Copyright (c) 2001 The Open Group, All Rights Reserved -->
<title>remove</title>
</head>
<body bgcolor="white">
<script type="text/javascript" language="JavaScript" src="../jscript/codes.js">
</script>
<basefont size="3"> <a name="remove"></a> <a name="tag_03_605"></a><!-- remove -->
<!--header start-->
<center><font size="2">The Open Group Base Specifications Issue 6<br>
IEEE Std 1003.1-2001<br>
Copyright &copy; 2001 The IEEE and The Open Group, All Rights reserved.</font></center>
<!--header end-->
<hr size="2" noshade>
<h4><a name="tag_03_605_01"></a>NAME</h4>
<blockquote>remove - remove a file</blockquote>
<h4><a name="tag_03_605_02"></a>SYNOPSIS</h4>
<blockquote class="synopsis">
<p><code><tt>#include &lt;<a href="../basedefs/stdio.h.html">stdio.h</a>&gt;<br>
<br>
int remove(const char *</tt><i>path</i><tt>);<br>
</tt></code></p>
</blockquote>
<h4><a name="tag_03_605_03"></a>DESCRIPTION</h4>
<blockquote>
<div class="box"><sup>[<a href="javascript:open_code('CX')">CX</a>]</sup> <img src="../images/opt-start.gif" alt="[Option Start]"
border="0"> The functionality described on this reference page is aligned with the ISO&nbsp;C standard. Any conflict between the
requirements described here and the ISO&nbsp;C standard is unintentional. This volume of IEEE&nbsp;Std&nbsp;1003.1-2001 defers to
the ISO&nbsp;C standard. <img src="../images/opt-end.gif" alt="[Option End]" border="0"></div>
<p>The <i>remove</i>() function shall cause the file named by the pathname pointed to by <i>path</i> to be no longer accessible by
that name. A subsequent attempt to open that file using that name shall fail, unless it is created anew.</p>
<p><sup>[<a href="javascript:open_code('CX')">CX</a>]</sup> <img src="../images/opt-start.gif" alt="[Option Start]" border="0"> If
<i>path</i> does not name a directory, <i>remove</i>(<i>path</i>) shall be equivalent to <i>unlink</i>(<i>path</i>).</p>
<p>If <i>path</i> names a directory, <i>remove</i>(<i>path</i>) shall be equivalent to <i>rmdir</i>(<i>path</i>). <img src=
"../images/opt-end.gif" alt="[Option End]" border="0"></p>
</blockquote>
<h4><a name="tag_03_605_04"></a>RETURN VALUE</h4>
<blockquote>
<p><sup>[<a href="javascript:open_code('CX')">CX</a>]</sup> <img src="../images/opt-start.gif" alt="[Option Start]" border="0">
Refer to <a href="rmdir.html"><i>rmdir</i>()</a> or <a href="unlink.html"><i>unlink</i>()</a> . <img src="../images/opt-end.gif"
alt="[Option End]" border="0"></p>
</blockquote>
<h4><a name="tag_03_605_05"></a>ERRORS</h4>
<blockquote>
<p><sup>[<a href="javascript:open_code('CX')">CX</a>]</sup> <img src="../images/opt-start.gif" alt="[Option Start]" border="0">
Refer to <a href="rmdir.html"><i>rmdir</i>()</a> or <a href="unlink.html"><i>unlink</i>()</a> . <img src="../images/opt-end.gif"
alt="[Option End]" border="0"></p>
</blockquote>
<hr>
<div class="box"><em>The following sections are informative.</em></div>
<h4><a name="tag_03_605_06"></a>EXAMPLES</h4>
<blockquote>
<h5><a name="tag_03_605_06_01"></a>Removing Access to a File</h5>
<p>The following example shows how to remove access to a file named <b>/home/cnd/old_mods</b>.</p>
<pre>
<tt>#include &lt;stdio.h&gt;
<br>
int status;
...
status = remove("/home/cnd/old_mods");
</tt>
</pre>
</blockquote>
<h4><a name="tag_03_605_07"></a>APPLICATION USAGE</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_605_08"></a>RATIONALE</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_605_09"></a>FUTURE DIRECTIONS</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_605_10"></a>SEE ALSO</h4>
<blockquote>
<p><a href="rmdir.html"><i>rmdir</i>()</a> , <a href="unlink.html"><i>unlink</i>()</a> , the Base Definitions volume of
IEEE&nbsp;Std&nbsp;1003.1-2001, <a href="../basedefs/stdio.h.html"><i>&lt;stdio.h&gt;</i></a></p>
</blockquote>
<h4><a name="tag_03_605_11"></a>CHANGE HISTORY</h4>
<blockquote>
<p>First released in Issue 3. Included for alignment with the POSIX.1-1988 standard and the ISO&nbsp;C standard.</p>
</blockquote>
<h4><a name="tag_03_605_12"></a>Issue 6</h4>
<blockquote>
<p>Extensions beyond the ISO&nbsp;C standard are marked.</p>
<p>The following new requirements on POSIX implementations derive from alignment with the Single UNIX Specification:</p>
<ul>
<li>
<p>The DESCRIPTION, RETURN VALUE, and ERRORS sections are updated so that if <i>path</i> is not a directory, <i>remove</i>() is
equivalent to <a href="../functions/unlink.html"><i>unlink</i>()</a>, and if it is a directory, it is equivalent to <a href=
"../functions/rmdir.html"><i>rmdir</i>()</a>.</p>
</li>
</ul>
</blockquote>
<div class="box"><em>End of informative text.</em></div>
<hr>
<hr size="2" noshade>
<center><font size="2"><!--footer start-->
UNIX &reg; is a registered Trademark of The Open Group.<br>
POSIX &reg; is a registered Trademark of The IEEE.<br>
[ <a href="../mindex.html">Main Index</a> | <a href="../basedefs/contents.html">XBD</a> | <a href=
"../utilities/contents.html">XCU</a> | <a href="../functions/contents.html">XSH</a> | <a href="../xrat/contents.html">XRAT</a>
]</font></center>
<!--footer end-->
<hr size="2" noshade>
</body>
</html>