posix-setgid.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.posix-setgid" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>posix_setgid</refname>
  <refpurpose>Set the GID of the current process</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>posix_setgid</methodname>
   <methodparam><type>int</type><parameter>gid</parameter></methodparam>
  </methodsynopsis>
  <para>
   Set the real group ID of the current process. This is a
   privileged function and needs appropriate privileges (usually
   root) on the system to be able to perform this function. The
   appropriate order of function calls is
   <function>posix_setgid</function> first,
   <function>posix_setuid</function> last.
  </para>
  <note>
   <para>
    If the caller is a super user, this will also set the effective
    group id.
   </para>
  </note>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>gid</parameter></term>
     <listitem>
      <para>
       The group id.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

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

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>posix_setgid</function> example</title>
    <para>
     This example will print out the effective group id, once it is changed.
    </para>
    <programlisting role="php">
<![CDATA[
<?php
echo 'My real group id is '.posix_getgid(); //20
posix_setgid(40);
echo 'My real group id is '.posix_getgid(); //40
echo 'My effective group id is '.posix_getegid(); //40
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>posix_getgrgid</function></member>
    <member><function>posix_getgid</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
-->