php-doc-en/reference/posix/functions/posix-setuid.xml
Martin Samesch 6ee18acb99 fixed word wrap in example
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@240949 c90b9560-bf6c-de11-be94-00142212c4b1
2007-08-09 11:50:14 +00:00

100 lines
2.4 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.10 $ -->
<refentry xml:id="function.posix-setuid" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>posix_setuid</refname>
<refpurpose>Set the UID of the current process</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>posix_setuid</methodname>
<methodparam><type>int</type><parameter>uid</parameter></methodparam>
</methodsynopsis>
<para>
Set the real user ID of the current process. This is a privileged
function that 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>uid</parameter></term>
<listitem>
<para>
The user 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_setuid</function> example</title>
<para>This example will show the currrent user id and then set
it to a different value.</para>
<programlisting role="php">
<![CDATA[
<?php
echo posix_getuid()."\n"; //10001
echo posix_geteuid()."\n"; //10001
posix_setuid(10000);
echo posix_getuid()."\n"; //10000
echo posix_geteuid()."\n"; //10000
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>posix_setgid</function></member>
<member><function>posix_seteuid</function></member>
<member><function>posix_getuid</function></member>
<member><function>posix_geteuid</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:"../../../../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
-->