php-doc-en/reference/filesystem/functions/linkinfo.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.linkinfo" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>linkinfo</refname>
  <refpurpose>Gets information about a link</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>int</type><type>false</type></type><methodname>linkinfo</methodname>
   <methodparam><type>string</type><parameter>path</parameter></methodparam>
  </methodsynopsis>
  <para>
   Gets information about a link.  
  </para>
  <para>
   This function is used to verify if a link (pointed to by
   <parameter>path</parameter>) really exists (using the same method as the
   S_ISLNK macro defined in <filename>stat.h</filename>).
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>path</parameter></term>
     <listitem>
      <para>
       Path to the link.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   <function>linkinfo</function> returns the <literal>st_dev</literal> field
   of the Unix C stat structure returned by the <literal>lstat</literal>
   system call. Returns a non-negative integer on success, -1 in case the link was not found, 
   or &false; if an open.base_dir violation occurs.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>linkinfo</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php

echo linkinfo('/vmlinuz'); // 835

?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>symlink</function></member>
    <member><function>link</function></member>
    <member><function>readlink</function></member>
   </simplelist>
  </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:"~/.phpdoc/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
-->