1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
|
<?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
-->
|
