mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-20 19:08:54 +00:00
96c9d88bad
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@297028 c90b9560-bf6c-de11-be94-00142212c4b1
86 lines
2.4 KiB
XML
86 lines
2.4 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id='function.proc-nice' xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>proc_nice</refname>
|
|
<refpurpose>Change the priority of the current process</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<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.
|
|
</para>
|
|
<para>
|
|
<function>proc_nice</function> is not related to
|
|
<function>proc_open</function> and its associated functions in any way.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>increment</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The increment value of the priority change.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
&return.success;
|
|
If an error occurs, like the user lacks permission to change the priority,
|
|
an error of level <constant>E_WARNING</constant> is also generated.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="notes">
|
|
&reftitle.notes;
|
|
<note>
|
|
<title>Availability</title>
|
|
<para>
|
|
<function>proc_nice</function> will only exist if your system has 'nice'
|
|
capabilities. 'nice' conforms to: SVr4, SVID EXT, AT&T, X/OPEN, BSD
|
|
4.3. This means that <function>proc_nice</function> is not available
|
|
on Windows.
|
|
</para>
|
|
</note>
|
|
</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
|
|
-->
|