Additional documentation for: ssh2_sftp_rename() and ssh2_sftp_unlink()

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@176092 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Sara Golemon 2004-12-30 19:42:20 +00:00
parent b8234dab10
commit 6e6bc33d3b
2 changed files with 47 additions and 7 deletions

View file

@ -1,5 +1,5 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<!-- Generated by xml_proto.php v2.1. Found in /scripts directory of phpdoc. -->
<refentry id="function.ssh2-sftp-rename">
<refnamediv>
@ -17,9 +17,29 @@
<methodparam><type>string</type><parameter>to</parameter></methodparam>
</methodsynopsis>
<para>
Renames a file on the remote filesystem
</para>
<simpara>
Renames a file on the remote filesystem.
</simpara>
<example>
<title>Renaming a file via sftp</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_rename($sftp, '/home/username/oldname', '/home/username/newname');
?>
]]>
</programlisting>
</example>
<simpara>
See Also:
<function>rename</function>
</simpara>
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<!-- Generated by xml_proto.php v2.1. Found in /scripts directory of phpdoc. -->
<refentry id="function.ssh2-sftp-unlink">
<refnamediv>
@ -16,9 +16,29 @@
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Deletes a file on the remote filesystem
</para>
</simpara>
<example>
<title>Deleting a file</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_unlink($sftp, '/home/username/stale_file');
?>
]]>
</programlisting>
</example>
<simpara>
See Also:
<function>unlink</function>
</simpara>
</refsect1>
</refentry>