sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-15 16:38:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Win32Service Doc update

Browse source 
Patch provided by jbnahan.

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@346737 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Christoph Michael Becker 2019-02-07 12:03:02 +00:00
parent d023717f0c
commit 767ded9aed
13 changed files with 588 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

239
reference/win32service/constants.xml
View file

@ -127,6 +127,18 @@
Notifies a paused service that it should resume.
</entry>
</row>
<row xml:id="constant.win32-service-control-deviceevent">
<entry><constant>WIN32_SERVICE_CONTROL_DEVICEEVENT</constant></entry>
<entry>0x0000000B</entry>
<entry>
</entry>
</row>
<row xml:id="constant.win32-service-control-hardwareprofilechange">
<entry><constant>WIN32_SERVICE_CONTROL_HARDWAREPROFILECHANGE</constant></entry>
<entry>0x0000000C</entry>
<entry>
</entry>
</row>
<row xml:id="constant.win32-service-control-interrogate">
<entry><constant>WIN32_SERVICE_CONTROL_INTERROGATE</constant></entry>
<entry>0x00000004</entry>
@ -135,6 +147,41 @@
to the service control manager.
</entry>
</row>
<row xml:id="constant.win32-service-control-netbindadd">
<entry><constant>WIN32_SERVICE_CONTROL_NETBINDADD</constant></entry>
<entry>0x00000007</entry>
<entry>
Notifies a network service that there is a new component for binding.
</entry>
</row>
<row xml:id="constant.win32-service-control-netbinddisable">
<entry><constant>WIN32_SERVICE_CONTROL_NETBINDDISABLE</constant></entry>
<entry>0x0000000A</entry>
<entry>
Notifies a network service that one of its bindings has been disabled.
</entry>
</row>
<row xml:id="constant.win32-service-control-netbindenable">
<entry><constant>WIN32_SERVICE_CONTROL_NETBINDENABLE</constant></entry>
<entry>0x00000009</entry>
<entry>
Notifies a network service that a disabled binding has been enabled.
</entry>
</row>
<row xml:id="constant.win32-service-control-netbindremove">
<entry><constant>WIN32_SERVICE_CONTROL_NETBINDREMOVE</constant></entry>
<entry>0x00000008</entry>
<entry>
Notifies a network service that a component for binding has been removed.
</entry>
</row>
<row xml:id="constant.win32-service-control-paramchange">
<entry><constant>WIN32_SERVICE_CONTROL_PARAMCHANGE</constant></entry>
<entry>0x00000006</entry>
<entry>
Notifies a service that its startup parameters have changed.
</entry>
</row>
<row xml:id="constant.win32-service-control-pause">
<entry><constant>WIN32_SERVICE_CONTROL_PAUSE</constant></entry>
<entry>0x00000002</entry>
@ -142,6 +189,12 @@
Notifies a service that it should pause.
</entry>
</row>
<row xml:id="constant.win32-service-control-powerevent">
<entry><constant>WIN32_SERVICE_CONTROL_POWEREVENT</constant></entry>
<entry>0x0000000D</entry>
<entry>
</entry>
</row>
<row xml:id="constant.win32-service-control-preshutdown">
<entry><constant>WIN32_SERVICE_CONTROL_PRESHUTDOWN</constant></entry>
<entry>0x0000000F</entry>
@ -152,6 +205,12 @@
by Windows Server 2003 and Windows XP/2000.
</entry>
</row>
<row xml:id="constant.win32-service-control-sessionchange">
<entry><constant>WIN32_SERVICE_CONTROL_SESSIONCHANGE</constant></entry>
<entry>0x0000000E</entry>
<entry>
</entry>
</row>
<row xml:id="constant.win32-service-control-shutdown">
<entry><constant>WIN32_SERVICE_CONTROL_SHUTDOWN</constant></entry>
<entry>0x00000005</entry>
@ -186,6 +245,38 @@
</row>
</thead>
<tbody>
<row xml:id="constant.win32-service-accept-hardwareprofilechange">
<entry><constant>WIN32_SERVICE_ACCEPT_HARDWAREPROFILECHANGE</constant></entry>
<entry>0x00000020</entry>
<entry>
The service is notified when the computer's hardware profile has changed.
This enables the system to send
<constant>WIN32_SERVICE_CONTROL_HARDWAREPROFILECHANGE</constant>
notifications to the service.
</entry>
</row>
<row xml:id="constant.win32-service-accept-netbindchange">
<entry><constant>WIN32_SERVICE_ACCEPT_NETBINDCHANGE</constant></entry>
<entry>0x00000010</entry>
<entry>
The service is a network component that can accept changes in its
binding without being stopped and restarted.
This control code allows the service to receive
<constant>WIN32_SERVICE_CONTROL_NETBINDADD</constant>,
<constant>WIN32_SERVICE_CONTROL_NETBINDREMOVE</constant>,
<constant>WIN32_SERVICE_CONTROL_NETBINDENABLE</constant>, and
<constant>WIN32_SERVICE_CONTROL_NETBINDDISABLE</constant> notifications.
</entry>
</row>
<row xml:id="constant.win32-service-accept-paramchange">
<entry><constant>WIN32_SERVICE_ACCEPT_PARAMCHANGE</constant></entry>
<entry>0x00000008</entry>
<entry>
The service can reread its startup parameters without being stopped and restarted.
This control code allows the service to receive
<constant>WIN32_SERVICE_CONTROL_PARAMCHANGE</constant> notifications.
</entry>
</row>
<row xml:id="constant.win32-service-accept-pause-continue">
<entry><constant>WIN32_SERVICE_ACCEPT_PAUSE_CONTINUE</constant></entry>
<entry>0x00000002</entry>
@ -195,6 +286,16 @@
<constant>WIN32_SERVICE_CONTROL_CONTINUE</constant> notifications.
</entry>
</row>
<row xml:id="constant.win32-service-accept-powerevent">
<entry><constant>WIN32_SERVICE_ACCEPT_POWEREVENT</constant></entry>
<entry>0x00000040</entry>
<entry>
The service is notified when the computer's power status has changed.
This enables the system to send
<constant>WIN32_SERVICE_CONTROL_POWEREVENT</constant> notifications
to the service.
</entry>
</row>
<row xml:id="constant.win32-service-accept-preshutdown">
<entry><constant>WIN32_SERVICE_ACCEPT_PRESHUTDOWN</constant></entry>
<entry>0x00000100</entry>
@ -205,6 +306,17 @@
Windows XP/2000.
</entry>
</row>
<row xml:id="constant.win32-service-accept-sessionchange">
<entry><constant>WIN32_SERVICE_ACCEPT_SESSIONCHANGE</constant></entry>
<entry>0x00000080</entry>
<entry>
The service is notified when the computer's session status has changed.
This enables the system to send
<constant>WIN32_SERVICE_CONTROL_SESSIONCHANGE</constant> notifications
to the service.
Windows 2000: This value is not supported
</entry>
</row>
<row xml:id="constant.win32-service-accept-shutdown">
<entry><constant>WIN32_SERVICE_ACCEPT_SHUTDOWN</constant></entry>
<entry>0x00000004</entry>
@ -222,6 +334,28 @@
receive <constant>WIN32_SERVICE_CONTROL_STOP</constant> notifications.
</entry>
</row>
<row xml:id="constant.win32-service-accept-timechange">
<entry><constant>WIN32_SERVICE_ACCEPT_TIMECHANGE</constant></entry>
<entry>0x00000200</entry>
<entry>
The service is notified when the system time has changed.
This enables the system to send
<constant>WIN32_SERVICE_CONTROL_TIMECHANGE</constant> notifications to the service.
Windows Server 2008, Windows Vista, Windows Server 2003,
and Windows XP/2000: This control code is not supported.
</entry>
</row>
<row xml:id="constant.win32-service-accept-triggerevent">
<entry><constant>WIN32_SERVICE_ACCEPT_TRIGGEREVENT</constant></entry>
<entry>0x00000400</entry>
<entry>
The service is notified when an event for which the service has registered occurs.
This enables the system to send
<constant>WIN32_SERVICE_CONTROL_TRIGGEREVENT</constant> notifications to the service.
Windows Server 2008, Windows Vista, Windows Server 2003,
and Windows XP/2000: This control code is not supported.
</entry>
</row>
</tbody>
</tgroup>
</table>
@ -239,6 +373,20 @@
</row>
</thead>
<tbody>
<row xml:id="constant.win32-service-boot-start">
<entry><constant>WIN32_SERVICE_BOOT_START</constant></entry>
<entry>0x00000000</entry>
<entry>
A device driver started by the system loader. This value is valid only for driver services.
</entry>
</row>
<row xml:id="constant.win32-service-system-start">
<entry><constant>WIN32_SERVICE_SYSTEM_START</constant></entry>
<entry>0x00000001</entry>
<entry>
A device driver started by the IoInitSystem function. This value is valid only for driver services.
</entry>
</row>
<row xml:id="constant.win32-service-auto-start">
<entry><constant>WIN32_SERVICE_AUTO_START</constant></entry>
<entry>0x00000002</entry>
@ -295,6 +443,26 @@
startup operation.
</entry>
</row>
<row xml:id="constant.win32-service-error-severe">
<entry><constant>WIN32_SERVICE_ERROR_SEVERE</constant></entry>
<entry>0x00000002</entry>
<entry>
The startup program logs the error in the event log.
If the last-known-good configuration is being started, the startup
operation continues. Otherwise, the system is restarted with the
last-known-good configuration.
</entry>
</row>
<row xml:id="constant.win32-service-error-critical">
<entry><constant>WIN32_SERVICE_ERROR_CRITICAL</constant></entry>
<entry>0x00000003</entry>
<entry>
The startup program logs the error in the event log, if possible.
If the last-known-good configuration is being started, the startup
operation fails. Otherwise, the system is restarted with the
last-known good configuration.
</entry>
</row>
</tbody>
</tgroup>
</table>
@ -554,6 +722,13 @@
The system is shutting down; this function cannot be called.
</entry>
</row>
<row xml:id="constant.win32-error-service-specific-error">
<entry><constant>WIN32_ERROR_SERVICE_SPECIFIC_ERROR</constant></entry>
<entry>0x0000042A</entry>
<entry>
The service has returned a service-specific error code.
</entry>
</row>
<row xml:id="constant.win32-no-error">
<entry><constant>WIN32_NO_ERROR</constant></entry>
<entry>0x00000000</entry>
@ -640,6 +815,70 @@
</table>
</section>
<section xml:id="win32service.constants.serviceinfos">
<table>
<title>Win32 Service informations</title>
<tgroup cols="3">
<thead>
<row>
<entry>Constant</entry>
<entry>Value</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row xml:id="constant.win32-info-service">
<entry><constant>Win32_INFO_SERVICE</constant></entry>
<entry>"service"</entry>
<entry>
</entry>
</row>
<row xml:id="constant.win32-info-display">
<entry><constant>Win32_INFO_DISPLAY</constant></entry>
<entry>"display"</entry>
<entry>
</entry>
</row>
<row xml:id="constant.win32-info-user">
<entry><constant>Win32_INFO_USER</constant></entry>
<entry>"user"</entry>
<entry>
</entry>
</row>
<row xml:id="constant.win32-info-password">
<entry><constant>Win32_INFO_PASSWORD</constant></entry>
<entry>"password"</entry>
<entry>
</entry>
</row>
<row xml:id="constant.win32-info-path">
<entry><constant>Win32_INFO_PATH</constant></entry>
<entry>"path"</entry>
<entry>
</entry>
</row>
<row xml:id="constant.win32-info-params">
<entry><constant>Win32_INFO_PARAMS</constant></entry>
<entry>"params"</entry>
<entry>
</entry>
</row>
<row xml:id="constant.win32-info-description">
<entry><constant>Win32_INFO_DESCRIPTION</constant></entry>
<entry>"description"</entry>
<entry>
</entry>
</row>
<row xml:id="constant.win32-info-start-type">
<entry><constant>Win32_INFO_START_TYPE</constant></entry>
<entry>"start_type"</entry>
<entry>
</entry>
</row>
</tbody>
</tgroup>
</table>
</section>
</appendix>
<!-- Keep this comment at the end of the file

1
reference/win32service/functions/win32-continue-service.xml
View file

@ -83,6 +83,7 @@
<member><function>win32_start_service</function></member>
<member><function>win32_stop_service</function></member>
<member><function>win32_pause_service</function></member>
<member><function>win32_send_custom_control</function></member>
<member><link linkend="win32service.constants.errors">Win32 Error Codes</link></member>
</simplelist>
</para>

9
reference/win32service/functions/win32-get-last-control-message.xml
View file

@ -39,6 +39,13 @@
<constant>WIN32_SERVICE_CONTROL_STOP</constant>.
</para>
</refsect1>
<refsect1 role="errors"><!-- {{{ -->
&reftitle.errors;
<para>
If SAPI is not <literal>"cli"</literal>, this function emits an <constant>E_ERROR</constant> level error.
</para>
</refsect1><!-- }}} -->
<refsect1 role="changelog"><!-- {{{ -->
&reftitle.changelog;
@ -70,6 +77,8 @@
<simplelist>
<member><function>win32_start_service_ctrl_dispatcher</function></member>
<member><function>win32_set_service_status</function></member>
<member><function>win32_set_service_exit_mode</function></member>
<member><function>win32_set_service_exit_code</function></member>
<member><link linkend="win32service.constants.servicecontrol">Win32Service Service Control Message Constants</link></member>
</simplelist>
</para>

1
reference/win32service/functions/win32-pause-service.xml
View file

@ -82,6 +82,7 @@
<member><function>win32_start_service</function></member>
<member><function>win32_stop_service</function></member>
<member><function>win32_continue_service</function></member>
<member><function>win32_send_custom_control</function></member>
<member><link linkend="win32service.constants.errors">Win32 Error Codes</link></member>
</simplelist>
</para>

9
reference/win32service/functions/win32-query-service-status.xml
View file

@ -79,7 +79,11 @@
<term><parameter>Win32ExitCode</parameter></term>
<listitem>
<para>
If the service exited, the return code from the process.
If the service exited, the return code from the process. This value is equal to
<constant>WIN32_ERROR_SERVICE_SPECIFIC_ERROR</constant>
if the exit mode is not gracefuly. See
<link linkend="win32service.constants.errors">Win32Service error codes</link> and
<link linkend="function.win32-set-service-exit-mode"><function>win32_set_service_exit_mode</function></link>
</para>
</listitem>
</varlistentry>
@ -88,7 +92,8 @@
<listitem>
<para>
If the service exited with an error condition, the service specific
code that is logged in the event log is visible here.
code that is logged in the event log is visible here. This value is equal
to the value defined by <link linkend="function.win32-set-service-exit-code"><function>win32_set_service_exit_code</function></link>
</para>
</listitem>
</varlistentry>

102
reference/win32service/functions/win32-send-custom-control.xml Normal file
View file

@ -0,0 +1,102 @@
<?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>int</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></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>
&win32service.noerror.false.error;
</para>
</refsect1><!-- }}} -->
<refsect1 role="errors"><!-- {{{ -->
&reftitle.errors;
<para>
If the control value is not between 128 and 255, this function emits an
<constant>E_ERROR</constant> level error.
</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
-->

91
reference/win32service/functions/win32-set-service-exit-code.xml Normal file
View file

@ -0,0 +1,91 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.win32-set-service-exit-code" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>win32_set_service_exit_code</refname>
<refpurpose>Define or return the exit code for the current running service</refpurpose>
</refnamediv>
<refsect1 role="description"><!-- {{{ -->
&reftitle.description;
<methodsynopsis role="procedural">
<type>int</type><methodname>win32_set_service_exit_code</methodname>
<methodparam choice="opt"><type>int</type><parameter>exitCode</parameter><initializer>1</initializer></methodparam>
</methodsynopsis>
<para>
Change or return the exit code. The exit code is used only if the exit mode is not graceful.
If the value is not zero, the recovery configuration can be used after
service fail. See
<link xlink:href="&url.microsoft.return.code;">Microsoft system error codes</link>
for more details
</para>
<caution>
<para>
This function work only in "cli" SAPI. On other SAPI
this function is disabled.
</para>
</caution>
</refsect1><!-- }}} -->
<refsect1 role="parameters"><!-- {{{ -->
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>exitCode</parameter></term>
<listitem>
<para>
The return code used on exit.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1><!-- }}} -->
<refsect1 role="returnvalues"><!-- {{{ -->
&reftitle.returnvalues;
<para>
Return the current or old exit code.
</para>
</refsect1><!-- }}} -->
<refsect1 role="errors"><!-- {{{ -->
&reftitle.errors;
<para>
If SAPI is not <literal>"cli"</literal>, this function emits an
<constant>E_ERROR</constant> level error.
</para>
</refsect1><!-- }}} -->
<refsect1 role="seealso"><!-- {{{ -->
&reftitle.seealso;
<simplelist>
<member><function>win32_start_service_ctrl_dispatcher</function></member>
<member><function>win32_set_service_status</function></member>
<member><function>win32_set_service_exit_mode</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
-->

89
reference/win32service/functions/win32-set-service-exit-mode.xml Normal file
View file

@ -0,0 +1,89 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.win32-set-service-exit-mode" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>win32_set_service_exit_mode</refname>
<refpurpose>Define or return the exit mode for the current running service</refpurpose>
</refnamediv>
<refsect1 role="description"><!-- {{{ -->
&reftitle.description;
<methodsynopsis role="procedural">
<type>bool</type><methodname>win32_set_service_exit_mode</methodname>
<methodparam choice="opt"><type>bool</type><parameter>gracefulMode</parameter><initializer>true</initializer></methodparam>
</methodsynopsis>
<para>
If <parameter>gracefulMode</parameter> parameter is provided, the exit mode
is changed. When the exit mode is not gracefuly, the exit code used can be set
with the <function>win32_set_service_exit_code</function> function.
</para>
<caution>
<para>
This function work only in "cli" SAPI. On other SAPI
this function is disabled.
</para>
</caution>
</refsect1><!-- }}} -->
<refsect1 role="parameters"><!-- {{{ -->
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>gracefulMode</parameter></term>
<listitem>
<para>
&true; for exit graceful. &false; for exit with error.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1><!-- }}} -->
<refsect1 role="returnvalues"><!-- {{{ -->
&reftitle.returnvalues;
<para>
Return the current or old exit mode.
</para>
</refsect1><!-- }}} -->
<refsect1 role="errors"><!-- {{{ -->
&reftitle.errors;
<para>
If SAPI is not <literal>"cli"</literal>, this function emits an
<constant>E_ERROR</constant> level error.
</para>
</refsect1><!-- }}} -->
<refsect1 role="seealso"><!-- {{{ -->
&reftitle.seealso;
<simplelist>
<member><function>win32_start_service_ctrl_dispatcher</function></member>
<member><function>win32_set_service_status</function></member>
<member><function>win32_set_service_exit_code</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
-->

9
reference/win32service/functions/win32-set-service-status.xml
View file

@ -74,6 +74,13 @@
&win32service.success.false.error;
</para>
</refsect1>
<refsect1 role="errors"><!-- {{{ -->
&reftitle.errors;
<para>
If SAPI is not <literal>"cli"</literal>, this function emits an <constant>E_ERROR</constant> level error.
</para>
</refsect1><!-- }}} -->
<refsect1 role="changelog"><!-- {{{ -->
&reftitle.changelog;
@ -105,6 +112,8 @@
<simplelist>
<member><function>win32_start_service_ctrl_dispatcher</function></member>
<member><function>win32_get_last_control_message</function></member>
<member><function>win32_set_service_exit_mode</function></member>
<member><function>win32_set_service_exit_code</function></member>
<member><link linkend="win32service.constants.servicestatus">Win32Service Service Status Constants</link></member>
</simplelist>
</para>

25
reference/win32service/functions/win32-start-service-ctrl-dispatcher.xml
View file

@ -11,6 +11,7 @@
<methodsynopsis>
<type>mixed</type><methodname>win32_start_service_ctrl_dispatcher</methodname>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>gracefulMode</parameter><initializer>true</initializer></methodparam>
</methodsynopsis>
<para>
@ -53,6 +54,15 @@
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>gracefulMode</parameter></term>
<listitem>
<para>
&true; for exit graceful. &false; for exit with error. See
<function>win32_set_service_exit_mode</function> for more details.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
@ -64,6 +74,13 @@
</para>
</refsect1>
<refsect1 role="errors"><!-- {{{ -->
&reftitle.errors;
<para>
If SAPI is not <literal>"cli"</literal>, this function emits an <constant>E_ERROR</constant> level error.
</para>
</refsect1><!-- }}} -->
<refsect1 role="examples">
&reftitle.examples;
<para>
@ -108,6 +125,12 @@ while (WIN32_SERVICE_CONTROL_STOP != win32_get_last_control_message()) {
</row>
</thead>
<tbody>
<row>
<entry>0.4.0</entry>
<entry>
The parameter <parameter>gracefulMode</parameter> has been added.
</entry>
</row>
<row>
<entry>0.2.0</entry>
<entry>
@ -126,6 +149,8 @@ while (WIN32_SERVICE_CONTROL_STOP != win32_get_last_control_message()) {
<simplelist>
<member><function>win32_set_service_status</function></member>
<member><function>win32_get_last_control_message</function></member>
<member><function>win32_set_service_exit_mode</function></member>
<member><function>win32_set_service_exit_code</function></member>
<member><link linkend="win32service.constants.errors">Win32 Error Codes</link></member>
</simplelist>
</para>

1
reference/win32service/functions/win32-start-service.xml
View file

@ -82,6 +82,7 @@
<member><function>win32_stop_service</function></member>
<member><function>win32_pause_service</function></member>
<member><function>win32_continue_service</function></member>
<member><function>win32_send_custom_control</function></member>
<member><link linkend="win32service.constants.errors">Win32 Error Codes</link></member>
</simplelist>
</para>

1
reference/win32service/functions/win32-stop-service.xml
View file

@ -82,6 +82,7 @@
<member><function>win32_start_service</function></member>
<member><function>win32_pause_service</function></member>
<member><function>win32_continue_service</function></member>
<member><function>win32_send_custom_control</function></member>
<member><link linkend="win32service.constants.errors">Win32 Error Codes</link></member>
</simplelist>
</para>

23
reference/win32service/versions.xml
View file

@ -4,16 +4,19 @@
Do NOT translate this file
-->
<versions>
<function name='win32-continue-service' from='PECL win32service SVN'/>
<function name='win32-create-service' from='PECL win32service SVN'/>
<function name='win32-delete-service' from='PECL win32service SVN'/>
<function name='win32-get-last-control-message' from='PECL win32service SVN'/>
<function name='win32-pause-service' from='PECL win32service SVN'/>
<function name='win32-query-service-status' from='PECL win32service SVN'/>
<function name='win32-set-service-status' from='PECL win32service SVN'/>
<function name='win32-start-service-ctrl-dispatcher' from='PECL win32service SVN'/>
<function name='win32-start-service' from='PECL win32service SVN'/>
<function name='win32-stop-service' from='PECL win32service SVN'/>
<function name='win32-continue-service' from='PECL win32service &gt;=0.1.0'/>
<function name='win32-create-service' from='PECL win32service &gt;=0.1.0'/>
<function name='win32-delete-service' from='PECL win32service &gt;=0.1.0'/>
<function name='win32-get-last-control-message' from='PECL win32service &gt;=0.1.0'/>
<function name='win32-pause-service' from='PECL win32service &gt;=0.1.0'/>
<function name='win32-query-service-status' from='PECL win32service &gt;=0.1.0'/>
<function name='win32-send-custom-control' from='PECL win32service &gt;=0.4.0'/>
<function name='win32-set-service-exit-code' from='PECL win32service &gt;=0.4.0'/>
<function name='win32-set-service-exit-mode' from='PECL win32service &gt;=0.4.0'/>
<function name='win32-set-service-status' from='PECL win32service &gt;=0.1.0'/>
<function name='win32-start-service-ctrl-dispatcher' from='PECL win32service &gt;=0.1.0'/>
<function name='win32-start-service' from='PECL win32service &gt;=0.1.0'/>
<function name='win32-stop-service' from='PECL win32service &gt;=0.1.0'/>
</versions>
<!-- Keep this comment at the end of the file