posix-geteuid.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.posix-geteuid" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>posix_geteuid</refname>
  <refpurpose>Return the effective user ID of the current process</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>int</type><methodname>posix_geteuid</methodname>
   <void/>
  </methodsynopsis>
  <para>
   Return the numeric effective user ID of the current process. See
   also <function>posix_getpwuid</function> for information on how
   to convert this into a useable username.
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns the user id, as an <type>integer</type>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>posix_geteuid</function> example</title>
    <para>This example will show the current user id then set the
    effective user id to a separate id using
    <function>posix_seteuid</function>, then show the difference between
    the real id and the effective id.</para>
    <programlisting role="php">
<![CDATA[
<?php
echo posix_getuid()."\n"; //10001
echo posix_geteuid()."\n"; //10001
posix_seteuid(10000);
echo posix_getuid()."\n"; //10001
echo posix_geteuid()."\n"; //10000
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>posix_getpwuid</function></member>
    <member><function>posix_getuid</function></member>
    <member><function>posix_setuid</function></member>
    <member>POSIX man page GETEUID(2)</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
-->