<!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>Set the thread title</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.setproctitle.html">setproctitle</a></div>
<div class="next" style="text-align: right; float: right;"><a href="book.xattr.html">xattr</a></div>
<div class="up"><a href="ref.proctitle.html">Proctitle Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.setthreadtitle" class="refentry">
<div class="refnamediv">
<h1 class="refname">setthreadtitle</h1>
<p class="verinfo">(PECL proctitle >= 0.1.2)</p><p class="refpurpose"><span class="refname">setthreadtitle</span> — <span class="dc-title">Set the thread title</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.setthreadtitle-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>setthreadtitle</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$title</code></span>
)</div>
<p class="para rdfs-comment">
Sets the thread title.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.setthreadtitle-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">title</code></em></span>
<dd>
<p class="para">
The title to use as the thread title.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.setthreadtitle-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.setthreadtitle-examples">
<h3 class="title">Examples</h3>
<div class="example" id="setthreadtitle.example.basic">
<p><strong>Example #1 <span class="function"><strong>setthreadtitle()</strong></span> example</strong></p>
<div class="example-contents"><p>
Running the example below will change the thread title (visible with
<em>ps c</em> for example).
</p></div>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />setthreadtitle</span><span style="color: #007700">(</span><span style="color: #DD0000">"myscript"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output
something similar to:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
$ ps c
PID TTY STAT TIME COMMAND
1178 pts/3 S 0:00 myscript
</pre></div>
</div>
</div>
</div>
<div class="refsect1 seealso" id="refsect1-function.setthreadtitle-seealso">
<h3 class="title">See Also</h3>
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.pcntl-fork.html" class="function" rel="rdfs-seeAlso">pcntl_fork()</a> - Forks the currently running process</span></li>
<li class="member"> <span class="function"><a href="function.setproctitle.html" class="function" rel="rdfs-seeAlso">setproctitle()</a> - Set the process title</span></li>
</ul>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.setproctitle.html">setproctitle</a></div>
<div class="next" style="text-align: right; float: right;"><a href="book.xattr.html">xattr</a></div>
<div class="up"><a href="ref.proctitle.html">Proctitle Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
