posix-getcwd.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.posix-getcwd" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>posix_getcwd</refname>
  <refpurpose>Pathname of current directory</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>false</type></type><methodname>posix_getcwd</methodname>
   <void/>
  </methodsynopsis>
  <para>
   Gets the absolute pathname of the script's current working directory.
   On error, it sets errno which can be checked using
   <function>posix_get_last_error</function>
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  &no.function.parameters;
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns a <type>string</type> of the absolute pathname on success.  
   On error, returns &false; and sets errno which can be checked with
   <function>posix_get_last_error</function>.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>posix_getcwd</function> example</title>
    <para>
     This example will return the absolute path of the current working 
     directory of the script.
    </para>
    <programlisting role="php">
<![CDATA[
<?php
echo 'My current working directory is '.posix_getcwd();
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>
 
 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    This function can fail on
    <itemizedlist>
     <listitem>
      <simpara>Read or Search permission was denied</simpara>
     </listitem>
     <listitem>
      <simpara>Pathname no longer exists</simpara>
     </listitem>
    </itemizedlist> 
   </para>
  </note>
 </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
-->