symlink.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.symlink">
 <refnamediv>
  <refname>symlink</refname>
  <refpurpose>Creates a symbolic link</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>symlink</methodname>
   <methodparam><type>string</type><parameter>target</parameter></methodparam>
   <methodparam><type>string</type><parameter>link</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>symlink</function> creates a symbolic link to the existing
   <parameter>target</parameter> with the specified name
   <parameter>link</parameter>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>target</parameter></term>
     <listitem>
      <para>
       Target of the link.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>link</parameter></term>
     <listitem>
      <para>
       The link name.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   The function fails, and issues <constant>E_WARNING</constant>,
   if <parameter>link</parameter> already exists.
   On Windows, the function also fails, and issues <constant>E_WARNING</constant>,
   if <parameter>target</parameter> does not exist.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Create a symbolic link</title>
    <programlisting role="php">
<![CDATA[
<?php
$target = 'uploads.php';
$link = 'uploads';
symlink($target, $link);

echo readlink($link);
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>is_link</function></member>
    <member><function>link</function></member>
    <member><function>readlink</function></member>
    <member><function>linkinfo</function></member>
    <member><function>unlink</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
-->