mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-22 20:08:55 +00:00
9af43469f4
Patch contributed by Sobak <msobaczewski@gmail.com>. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@350654 c90b9560-bf6c-de11-be94-00142212c4b1
95 lines
2.7 KiB
XML
95 lines
2.7 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id='function.proc-terminate' xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>proc_terminate</refname>
|
|
<refpurpose>Kills a process opened by proc_open</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>proc_terminate</methodname>
|
|
<methodparam><type>resource</type><parameter>process</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>signal</parameter><initializer>15</initializer></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Signals a <parameter>process</parameter> (created using
|
|
<function>proc_open</function>) that it should terminate.
|
|
<function>proc_terminate</function> returns immediately and does not wait
|
|
for the process to terminate.
|
|
</para>
|
|
<para>
|
|
<function>proc_terminate</function> allows you terminate the process and
|
|
continue with other tasks. You may poll the process (to see if it has
|
|
stopped yet) by using the <function>proc_get_status</function> function.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>process</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The <function>proc_open</function> <type>resource</type> that will
|
|
be closed.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>signal</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
This optional parameter is only useful on <acronym>POSIX</acronym>
|
|
operating systems; you may specify a signal to send to the process
|
|
using the <literal>kill(2)</literal> system call. The default is
|
|
<literal>SIGTERM</literal>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns the termination status of the process that was run.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>proc_open</function></member>
|
|
<member><function>proc_close</function></member>
|
|
<member><function>proc_get_status</function></member>
|
|
</simplelist>
|
|
</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:"~/.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
|
|
-->
|