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
150
151
152
153
154
155
156
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.win32-send-custom-control" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>win32_send_custom_control</refname>
<refpurpose>Send a custom control to the service</refpurpose>
</refnamediv>
<refsect1 role="description"><!-- {{{ -->
&reftitle.description;
<methodsynopsis role="procedural">
<type>void</type><methodname>win32_send_custom_control</methodname>
<methodparam><type>string</type><parameter>servicename</parameter></methodparam>
<methodparam><type>int</type><parameter>control</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>machine</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
See <link xlink:href="&url.microsoft.controlservice;">Microsoft ControlService function</link> for more details
</para>
</refsect1><!-- }}} -->
<refsect1 role="parameters"><!-- {{{ -->
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>servicename</parameter></term>
<listitem>
<para>
The short name of the service.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>control</parameter></term>
<listitem>
<para>
The custom contole value between 128 and 255.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>machine</parameter></term>
<listitem>
<para>
Optional machine name. If omitted, the local machine is used.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1><!-- }}} -->
<refsect1 role="returnvalues"><!-- {{{ -->
&reftitle.returnvalues;
<para>
&return.void;
</para>
<para>
Prior to version 1.0.0, &win32service.noerror.false.error;
</para>
</refsect1><!-- }}} -->
<refsect1 role="errors"><!-- {{{ -->
&reftitle.errors;
<para>
Prior to version 1.0.0, if the control value is not between 128 and 255, this function emits an
<constant>E_ERROR</constant> level error.
</para>
<para>
A <classname>ValueError</classname> is thrown if the
value of <parameter>servicename</parameter> parameter is empty.
</para>
<para>
A <classname>ValueError</classname> is thrown if the
value of <parameter>control</parameter> parameter is not between 128 and 255.
</para>
<para>
A <classname>Win32ServiceException</classname> is thrown on error.
</para>
</refsect1><!-- }}} -->
<refsect1 role="changelog"><!-- {{{ -->
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>PECL win32service 1.0.0</entry>
<entry>
Throws a <classname>ValueError</classname> on invalid data in parameters,
previously &false; was returned.
</entry>
</row>
<row>
<entry>PECL win32service 1.0.0</entry>
<entry>
Throws a <classname>Win32ServiceException</classname> on error,
previously a
<link xmlns="http://docbook.org/ns/docbook" linkend="win32service.constants.errors">Win32 Error Code</link>
was returned.
</entry>
</row>
<row>
<entry>PECL win32service 1.0.0</entry>
<entry>
The return type is now <type>void</type>, previously it was <type>mixed</type>.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1><!-- }}} -->
<refsect1 role="seealso"><!-- {{{ -->
&reftitle.seealso;
<simplelist>
<member><function>win32_start_service</function></member>
<member><function>win32_stop_service</function></member>
<member><function>win32_pause_service</function></member>
<member><function>win32_continue_service</function></member>
<member><link linkend="win32service.constants.errors">Win32 Error Codes</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
-->
|
