php-doc-en/reference/pcntl/functions/pcntl-async-signals.xml
Christoph Michael Becker 65d415fd32 Fix see-also link to declare
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@342918 c90b9560-bf6c-de11-be94-00142212c4b1
2017-08-22 21:43:14 +00:00

76 lines
2.3 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.pcntl-async-signals" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>pcntl_async_signals</refname>
<refpurpose>Enable/disable asynchronous signal handling or return the old setting</refpurpose>
</refnamediv>
<refsect1 role="description"><!-- {{{ -->
&reftitle.description;
<methodsynopsis role="procedural">
<type>bool</type><methodname>pcntl_async_signals</methodname>
<methodparam choice="opt"><type>bool</type><parameter>on</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
If the <parameter>on</parameter> parameter is omitted,
<function>pcntl_async_signals</function> returns whether asynchronous signal
handling is enabled. Otherwise, asynchronous signal handling is enabled or
disabled.
</para>
</refsect1><!-- }}} -->
<refsect1 role="parameters"><!-- {{{ -->
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>on</parameter></term>
<listitem>
<para>
Whether asynchronous signal handling should be enabled.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1><!-- }}} -->
<refsect1 role="returnvalues"><!-- {{{ -->
&reftitle.returnvalues;
<para>
When used as getter (that is without the optional parameter) it returns
whether asynchronous signal handling is enabled. When used as setter (that is
with the optional parameter given), it returns whether asynchronous signal
handling was enabled <emphasis>before</emphasis> the function call.
</para>
</refsect1><!-- }}} -->
<refsect1 role="seealso"><!-- {{{ -->
&reftitle.seealso;
<simplelist>
<member><link linkend="control-structures.declare">declare</link></member>
</simplelist>
</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
-->