php-doc-en/reference/win32service/functions/win32-get-last-control-message.xml
2010-10-21 18:00:56 +00:00

67 lines
2.1 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.win32-get-last-control-message" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>win32_get_last_control_message</refname>
<refpurpose>Returns the last control message that was sent to this service</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>win32_get_last_control_message</methodname>
<void/>
</methodsynopsis>
<para>
Returns the control code that was last sent to this service process.
When running as a service you should periodically check this to determine if
your service needs to stop running.
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a control constant which will be one of the
<link linkend="win32service.constants.servicecontrol">Win32Service Service Control Message Constants</link>:
<constant>WIN32_SERVICE_CONTROL_CONTINUE</constant>,
<constant>WIN32_SERVICE_CONTROL_INTERROGATE</constant>,
<constant>WIN32_SERVICE_CONTROL_PAUSE</constant>,
<constant>WIN32_SERVICE_CONTROL_PRESHUTDOWN</constant>,
<constant>WIN32_SERVICE_CONTROL_SHUTDOWN</constant>,
<constant>WIN32_SERVICE_CONTROL_STOP</constant>.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>win32_start_service_ctrl_dispatcher</function></member>
<member><link linkend="win32service.constants.servicecontrol">Win32Service Service Control Message 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
-->