/
sapi-windows-set-ctrl-handler.xml
136 lines (129 loc) · 4.64 KB
/
sapi-windows-set-ctrl-handler.xml
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
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 426d9a8f156bca7be9cb5475e24ba104ee814bc1 Maintainer: rjhdby Status: ready -->
<!-- Reviewed: no -->
<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>Установить или удалить обработчик события CTRL</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>
Устанавливает или удаляет обработчик события <literal>CTRL</literal>,
который позволит процессам Windows CLI перехватывать или
игнорировать события <literal>CTRL+C</literal> и
<literal>CTRL+BREAK</literal>. Обратите внимание, что в
многопоточном окружение это возможно только при вызове
из главного потока.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>handler</parameter></term>
<listitem>
<para>
Функция обратного вызова, которая будет установлена или удалена.
Эта функция будет вызываться при наступлении событий
<literal>CTRL+C</literal> и <literal>CTRL+BREAK</literal>.
Функция должна иметь следующую сигнатуру:
<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>
Полученное событие <literal>CTRL</literal>;
<constant>PHP_WINDOWS_EVENT_CTRL_C</constant>
или <constant>PHP_WINDOWS_EVENT_CTRL_BREAK</constant>.
</simpara>
</listitem>
</varlistentry>
</variablelist>
Установка параметра <parameter>handler</parameter> в значение
&null; приведёт к игнорированию событий
<literal>CTRL+C</literal>, но не <literal>CTRL+BREAK</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>add</parameter></term>
<listitem>
<para>
Если &true;, то обработчик будет установлен. Если &false;, то
удалён.
</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>Использование <function>sapi_windows_set_ctrl_handler</function></title>
<para>
В этом примере показано, как перехватывать события <literal>CTRL</literal>.
</para>
<programlisting role="php">
<![CDATA[
<?php
function ctrl_handler(int $event)
{
switch ($event) {
case PHP_WINDOWS_EVENT_CTRL_C:
echo "Вы нажали CTRL+C\n";
break;
case PHP_WINDOWS_EVENT_CTRL_BREAK:
echo "Вы нажали CTRL+BREAK\n";
break;
}
}
sapi_windows_set_ctrl_handler('ctrl_handler');
while (true); // Бесконечный цикл
?>
]]>
</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
-->