<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <title>Get the priority of any process</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.pcntl-get-last-error.html">pcntl_get_last_error</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.pcntl-setpriority.html">pcntl_setpriority</a></div> <div class="up"><a href="ref.pcntl.html">PCNTL Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="function.pcntl-getpriority" class="refentry"> <div class="refnamediv"> <h1 class="refname">pcntl_getpriority</h1> <p class="verinfo">(PHP 5)</p><p class="refpurpose"><span class="refname">pcntl_getpriority</span> — <span class="dc-title">Get the priority of any process</span></p> </div> <div class="refsect1 description" id="refsect1-function.pcntl-getpriority-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type">int</span> <span class="methodname"><strong>pcntl_getpriority</strong></span> ([ <span class="methodparam"><span class="type">int</span> <code class="parameter">$pid</code><span class="initializer"> = getmypid()</span></span> [, <span class="methodparam"><span class="type">int</span> <code class="parameter">$process_identifier</code><span class="initializer"> = PRIO_PROCESS</span></span> ]] )</div> <p class="para rdfs-comment"> <span class="function"><strong>pcntl_getpriority()</strong></span> gets the priority of <em><code class="parameter">pid</code></em>. Because priority levels can differ between system types and kernel versions, please see your system's getpriority(2) man page for specific details. </p> </div> <div class="refsect1 parameters" id="refsect1-function.pcntl-getpriority-parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <span class="term"><em><code class="parameter">pid</code></em></span> <dd> <p class="para"> If not specified, the pid of the current process is used. </p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">process_identifier</code></em></span> <dd> <p class="para"> One of <strong><code>PRIO_PGRP</code></strong>, <strong><code>PRIO_USER</code></strong> or <strong><code>PRIO_PROCESS</code></strong>. </p> </dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-function.pcntl-getpriority-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> <span class="function"><strong>pcntl_getpriority()</strong></span> returns the priority of the process or <strong><code>FALSE</code></strong> on error. A lower numerical value causes more favorable scheduling. </p> <div class="warning"><strong class="warning">Warning</strong><p class="simpara">This function may return Boolean <strong><code>FALSE</code></strong>, but may also return a non-Boolean value which evaluates to <strong><code>FALSE</code></strong>. Please read the section on <a href="language.types.boolean.html" class="link">Booleans</a> for more information. Use <a href="language.operators.comparison.html" class="link">the === operator</a> for testing the return value of this function.</p></div> </div> <div class="refsect1 seealso" id="refsect1-function.pcntl-getpriority-seealso"> <h3 class="title">See Also</h3> <p class="para"> <ul class="simplelist"> <li class="member"> <span class="function"><a href="function.pcntl-setpriority.html" class="function" rel="rdfs-seeAlso">pcntl_setpriority()</a> - Change the priority of any process</span></li> </ul> </p> </div> </div><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.pcntl-get-last-error.html">pcntl_get_last_error</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.pcntl-setpriority.html">pcntl_setpriority</a></div> <div class="up"><a href="ref.pcntl.html">PCNTL Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>