php-doc-en/reference/posix/functions/posix-getcwd.xml
Logan Buesching 07631eab81 Removed shebang's as requested by Nuno.
Fixed structure of refsects


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@235205 c90b9560-bf6c-de11-be94-00142212c4b1
2007-05-08 03:47:42 +00:00

89 lines
2.1 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.10 $ -->
<refentry id="function.posix-getcwd">
<refnamediv>
<refname>posix_getcwd</refname>
<refpurpose>Pathname of current directory</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</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="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:"../../../../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
-->