sapi-windows-set-ctrl-handler.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.sapi-windows-set-ctrl-handler" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>sapi_windows_set_ctrl_handler</refname>
  <refpurpose>Set or remove a CTRL event handler</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>sapi_windows_set_ctrl_handler</methodname>
   <methodparam><type class="union"><type>callable</type><type>null</type></type><parameter>handler</parameter></methodparam>
   <methodparam choice="opt"><type>bool</type><parameter>add</parameter><initializer>&true;</initializer></methodparam>
  </methodsynopsis>
  <para>
   Sets or removes a <literal>CTRL</literal> event handler, which allows Windows
   CLI processes to intercept or ignore <literal>CTRL+C</literal> and
   <literal>CTRL+BREAK</literal> events. Note that in multithreaded environments,
   this is only possible when called from the main thread.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>handler</parameter></term>
    <listitem>
     <para>
      A callback function to set or remove. If set, this function will be called
      whenever a
      <keycombo action='simul'>
       <keycap>CTRL</keycap>
       <keycap>C</keycap>
      </keycombo>
      or
      <keycombo action='simul'>
       <keycap>CTRL</keycap>
       <keycap>BREAK</keycap>
      </keycombo>
      event occurs.
      The function is supposed to have the following signature:
      <methodsynopsis>
       <type>void</type><methodname>handler</methodname>
       <methodparam><type>int</type><parameter>event</parameter></methodparam>
      </methodsynopsis>
      <variablelist>
       <varlistentry>
        <term><parameter>event</parameter></term>
        <listitem>
         <simpara>
          The <keycap>CTRL</keycap> event which has been received;
          either <constant>PHP_WINDOWS_EVENT_CTRL_C</constant>
          or <constant>PHP_WINDOWS_EVENT_CTRL_BREAK</constant>.
         </simpara>
        </listitem>
       </varlistentry>
      </variablelist>
      Setting a &null; <parameter>handler</parameter> causes the process to ignore
      <keycombo action='simul'>
       <keycap>CTRL</keycap>
       <keycap>C</keycap>
      </keycombo>
      events, but not
      <keycombo action='simul'>
       <keycap>CTRL</keycap>
       <keycap>BREAK</keycap>
      </keycombo>
      events.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>add</parameter></term>
    <listitem>
     <para>
      If &true;, the handler is set. If &false;, the handler is removed.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example xml:id="sapi-windows-set-ctrl-handler.example.basic">
   <title>Basic <function>sapi_windows_set_ctrl_handler</function> Usage</title>
   <para>
     This example shows how to intercept <literal>CTRL</literal> events.
   </para>
   <programlisting role="php">
<![CDATA[
<?php
function ctrl_handler(int $event)
{
    switch ($event) {
        case PHP_WINDOWS_EVENT_CTRL_C:
            echo "You have pressed CTRL+C\n";
            break;
        case PHP_WINDOWS_EVENT_CTRL_BREAK:
            echo "You have pressed CTRL+BREAK\n";
            break;
    }
}

sapi_windows_set_ctrl_handler('ctrl_handler');
while (true); // infinite loop, so the handler can be triggered
?>
]]>
   </programlisting>
  </example>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <simplelist>
   <member><function>sapi_windows_generate_ctrl_event</function></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
-->