php-doc-en/reference/posix/functions/posix-setegid.xml
Martin Samesch d38f741677 missing word
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@240967 c90b9560-bf6c-de11-be94-00142212c4b1
2007-08-09 17:09:46 +00:00

103 lines
2.5 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.10 $ -->
<refentry xml:id="function.posix-setegid" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>posix_setegid</refname>
<refpurpose>Set the effective GID of the current process</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>posix_setegid</methodname>
<methodparam><type>int</type><parameter>gid</parameter></methodparam>
</methodsynopsis>
<para>
Set the effective 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.
</para>
</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_setegid</function> example</title>
<para>
This example will print out the effective group id, once changed.
</para>
<programlisting role="php">
<![CDATA[
<?php
echo 'My real group id is '.posix_getgid(); //20
posix_setegid(40);
echo 'My real group id is '.posix_getgid(); //20
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> for information on how to convert a
group id into a useable group name
</member>
<member><function>posix_getgid</function> get real group id.</member>
<member><function>posix_setgid</function> change the effective group
id</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:"../../../../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
-->