php-doc-en/reference/ssh2/functions/ssh2-sftp-readlink.xml

<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.3 $ -->
<!-- Generated by xml_proto.php v2.1. Found in /scripts directory of phpdoc. -->
<refentry id="function.ssh2-sftp-readlink">
 <refnamediv>
  <refname>ssh2_sftp_readlink</refname>
  <refpurpose>Return the target of a symbolic link</refpurpose>
 </refnamediv>
 <refsect1>
  <title>Description</title>
  <methodsynopsis>
   <type>string</type><methodname>ssh2_sftp_readlink</methodname>
   <methodparam><type>resource</type><parameter>sftp</parameter></methodparam>
   <methodparam><type>string</type><parameter>link</parameter></methodparam>
  </methodsynopsis>

  <simpara>
   Returns the target of a symbolic link.
  </simpara>

  <example>
   <title>Reading a symbolic link</title>
   <programlisting role="php">
<![CDATA[
<?php
$connection = ssh2_connect('shell.example.com', 22);
ssh2_auth_password($connection, 'username', 'password');
$sftp = ssh2_sftp($connection);

$target = ssh2_sftp_readlink($sftp, '/tmp/mysql.sock');
/* $target is now (e.g.): '/var/run/mysql.sock' */
?>
]]>
   </programlisting>
  </example>

  <simpara>
   See Also:
   <function>readlink</function>, and
   <function>ssh2_sftp_symlink</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
-->