php-doc-en/reference/pcntl/functions/pcntl-setpriority.xml
Daniel Egeberg 96c9d88bad Converted to utf-8
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@297028 c90b9560-bf6c-de11-be94-00142212c4b1
2010-03-28 22:10:10 +00:00

98 lines
2.8 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id='function.pcntl-setpriority' xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>pcntl_setpriority</refname>
<refpurpose>Change the priority of any process</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>pcntl_setpriority</methodname>
<methodparam><type>int</type><parameter>priority</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>pid</parameter><initializer>getmypid()</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>process_identifier</parameter><initializer>PRIO_PROCESS</initializer></methodparam>
</methodsynopsis>
<para>
<function>pcntl_setpriority</function> sets the priority of
<parameter>pid</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>priority</parameter></term>
<listitem>
<para>
<parameter>priority</parameter> is generally a value in the range
<literal>-20</literal> to <literal>20</literal>. The default priority
is <literal>0</literal> while a lower numerical value causes more
favorable scheduling. Because priority levels can differ between
system types and kernel versions, please see your system's setpriority(2)
man page for specific details.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>pid</parameter></term>
<listitem>
<para>
If not specified, the pid of the current process is used.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>process_identifier</parameter></term>
<listitem>
<para>
One of <constant>PRIO_PGRP</constant>, <constant>PRIO_USER</constant>
or <constant>PRIO_PROCESS</constant>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>pcntl_getpriority</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
-->