php-doc-en/reference/ssh2/functions/ssh2-sftp-rmdir.xml
Friedhelm Betz a46b190224 typo in examples, spotted byuser notes
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@209460 c90b9560-bf6c-de11-be94-00142212c4b1
2006-03-16 11:10:22 +00:00

70 lines
1.9 KiB
XML

<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.4 $ -->
<!-- Generated by xml_proto.php v2.1. Found in /scripts directory of phpdoc. -->
<refentry id="function.ssh2-sftp-rmdir">
<refnamediv>
<refname>ssh2_sftp_rmdir</refname>
<refpurpose>
Remove a directory
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>ssh2_sftp_rmdir</methodname>
<methodparam><type>resource</type><parameter>sftp</parameter></methodparam>
<methodparam><type>string</type><parameter>dirname</parameter></methodparam>
</methodsynopsis>
<simpara>
Removes a directory from the remote file server.
This function is similar to using <function>rmdir</function> with the
<link linkend="wrappers.ssh2">ssh2.sftp://</link> wrapper.
</simpara>
<example>
<title>Removing a directory on a remote server</title>
<programlisting role="php">
<![CDATA[
<?php
$connection = ssh2_connect('shell.example.com', 22);
ssh2_auth_password($connection, 'username', 'password');
$sftp = ssh2_sftp($connection);
ssh2_sftp_rmdir($sftp, '/home/username/deltodel');
/* Or: rmdir("ssh2.sftp://$sftp/home/username/dirtodel"); */
?>
]]>
</programlisting>
</example>
<simpara>
See Also:
<function>rmdir</function>, and
<function>ssh2_sftp_mkdir</function>
</simpara>
</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
-->