php-doc-en/reference/exec/functions/proc-nice.xml
2004-08-12 21:21:36 +00:00

60 lines
1.9 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<refentry id='function.proc-nice'>
<refnamediv>
<refname>proc_nice</refname>
<refpurpose>
Change the priority of the current process
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>proc_nice</methodname>
<methodparam><type>int</type><parameter>increment</parameter></methodparam>
</methodsynopsis>
<para>
<function>proc_nice</function> changes the priority of the current
process by the amount specified in <parameter>increment</parameter>. A
positive <parameter>increment</parameter> will lower the priority of the
current process, whereas a negative <parameter>increment</parameter>
will raise the priority. If an error occurs, like the user lacks
permission to change the priority, an error of level
<constant>E_WARNING</constant> is generated and &false; is returned.
Otherwise, &true; is returned.
</para>
<note>
<para>
<function>proc_nice</function> will only exist if your system has 'nice'
capabilities. 'nice' conforms to: SVr4, SVID EXT, AT&amp;T, X/OPEN, BSD
4.3. This means that <function>proc_nice</function> is not available
on Windows.
</para>
</note>
<para>
<function>proc_nice</function> is not related to
<function>proc_open</function> and its associated functions in any way.
</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
-->