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
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 304597 $ -->
<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. -->
<refentry xml:id="function.win32-set-service-status" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>win32_set_service_status</refname>
<refpurpose>Update the service status</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>win32_set_service_status</methodname>
<methodparam><type>int</type><parameter>status</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>checkpoint</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
Informs the SCM of the current status of a running service.
This call is only valid for a running service process.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>status</parameter></term>
<listitem>
<para>
The service status code, one of
<constant>WIN32_SERVICE_RUNNING</constant>,
<constant>WIN32_SERVICE_STOPPED</constant>,
<constant>WIN32_SERVICE_STOP_PENDING</constant>,
<constant>WIN32_SERVICE_START_PENDING</constant>,
<constant>WIN32_SERVICE_CONTINUE_PENDING</constant>,
<constant>WIN32_SERVICE_PAUSE_PENDING</constant>,
<constant>WIN32_SERVICE_PAUSED</constant>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>checkpoint</parameter></term>
<listitem>
<para>
The checkpoint value the service increments periodically to report its
progress during a lengthy start, stop, pause, or continue operation.
For example, the service should increment this value as it completes
each step of its initialization when it is starting up.
</para>
<para>
The <parameter>checkpoint</parameter> is only valid when the
<parameter>status</parameter> is one of
<constant>WIN32_SERVICE_STOP_PENDING</constant>,
<constant>WIN32_SERVICE_START_PENDING</constant>,
<constant>WIN32_SERVICE_CONTINUE_PENDING</constant> or
<constant>WIN32_SERVICE_PAUSE_PENDING</constant>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&win32service.success.false.error;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>win32_start_service_ctrl_dispatcher</function></member>
<member><link linkend="win32service.constants.servicestatus">Win32Service Service Status Constants</link></member>
</simplelist>
</para>
</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
-->
|
