php-doc-en/reference/filesystem/functions/rmdir.xml
Jakub Vrana 6e83b49413 Context parameter (bug #32499)
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@183271 c90b9560-bf6c-de11-be94-00142212c4b1
2005-03-31 15:01:44 +00:00

55 lines
1.7 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.9 $ -->
<!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.2 -->
<refentry id="function.rmdir">
<refnamediv>
<refname>rmdir</refname>
<refpurpose>Removes directory</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>rmdir</methodname>
<methodparam><type>string</type><parameter>dirname</parameter></methodparam>
<methodparam choice="opt"><type>resource</type><parameter>context</parameter></methodparam>
</methodsynopsis>
<para>
Attempts to remove the directory named by <parameter>dirname</parameter>.
The directory must be empty, and the relevant permissions must permit this.
&return.success;
</para>
<note>
<simpara>
As of PHP 5.0.0 <function>rmdir</function> can also be
used with <emphasis>some</emphasis> URL wrappers. Refer to <xref linkend="wrappers"/>
for a listing of which wrappers support <function>rmdir</function>.
</simpara>
</note>
&note.context-support;
&note.sm.uidcheck.dir;
<para>
See also <function>mkdir</function> and <function>unlink</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->