<!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>Closes process file pointer</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.pathinfo.html">pathinfo</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.popen.html">popen</a></div>
<div class="up"><a href="ref.filesystem.html">Filesystem Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.pclose" class="refentry">
<div class="refnamediv">
<h1 class="refname">pclose</h1>
<p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">pclose</span> — <span class="dc-title">Closes process file pointer</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.pclose-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">int</span> <span class="methodname"><strong>pclose</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$handle</code></span>
)</div>
<p class="para rdfs-comment">
Closes a file pointer to a pipe opened by <span class="function"><a href="function.popen.html" class="function">popen()</a></span>.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.pclose-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">handle</code></em></span>
<dd>
<p class="para">
The file pointer must be valid, and must have been returned by a
successful call to <span class="function"><a href="function.popen.html" class="function">popen()</a></span>.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.pclose-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the termination status of the process that was run. In case of
an error then <em>-1</em> is returned.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.pclose-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-2419">
<p><strong>Example #1 <span class="function"><strong>pclose()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$handle </span><span style="color: #007700">= </span><span style="color: #0000BB">popen</span><span style="color: #007700">(</span><span style="color: #DD0000">'/bin/ls'</span><span style="color: #007700">, </span><span style="color: #DD0000">'r'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">pclose</span><span style="color: #007700">(</span><span style="color: #0000BB">$handle</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 notes" id="refsect1-function.pclose-notes">
<h3 class="title">Notes</h3>
<blockquote class="note"><p><strong class="note">Note</strong>:
<strong>Unix Only:</strong><br />
<p class="para">
<span class="function"><strong>pclose()</strong></span> is internally implemented using the
<em>waitpid(3)</em> system call. To obtain the real exit
status code the <span class="function"><a href="function.pcntl-wexitstatus.html" class="function">pcntl_wexitstatus()</a></span> function
should be used.
</p>
</p></blockquote>
</div>
<div class="refsect1 seealso" id="refsect1-function.pclose-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.popen.html" class="function" rel="rdfs-seeAlso">popen()</a> - Opens process file pointer</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.pathinfo.html">pathinfo</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.popen.html">popen</a></div>
<div class="up"><a href="ref.filesystem.html">Filesystem Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
