<?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>
  
  <caution>
   <para>
    Since version 0.2.0, this function work only in "cli" SAPI. On other SAPI 
    this function is disabled.
   </para>
  </caution>
  
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  &no.function.parameters;
 </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_DEVICEEVENT</constant>,
   <constant>WIN32_SERVICE_CONTROL_HARDWAREPROFILECHANGE</constant>,
   <constant>WIN32_SERVICE_CONTROL_INTERROGATE</constant>,
   <constant>WIN32_SERVICE_CONTROL_NETBINDADD</constant>,
   <constant>WIN32_SERVICE_CONTROL_NETBINDDISABLE</constant>,
   <constant>WIN32_SERVICE_CONTROL_NETBINDENABLE</constant>,
   <constant>WIN32_SERVICE_CONTROL_NETBINDREMOVE</constant>,
   <constant>WIN32_SERVICE_CONTROL_PARAMCHANGE</constant>,
   <constant>WIN32_SERVICE_CONTROL_PAUSE</constant>,
   <constant>WIN32_SERVICE_CONTROL_POWEREVENT</constant>,
   <constant>WIN32_SERVICE_CONTROL_PRESHUTDOWN</constant>,
   <constant>WIN32_SERVICE_CONTROL_SESSIONCHANGE</constant>,
   <constant>WIN32_SERVICE_CONTROL_SHUTDOWN</constant>,
   <constant>WIN32_SERVICE_CONTROL_STOP</constant>.
  </para>
  <para>
   If the value is between 128 and 255, the control code is custom.
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   Prior to version 1.0.0, if the SAPI is not <literal>"cli"</literal>, this function emits an 
<constant>E_ERROR</constant> level error.
  </para>
   <para>
    As of version 1.0.0, will throw a 
    <classname>Win32ServiceException</classname> if SAPI is not 
    <literal>"cli"</literal>
   </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 0.2.0</entry>
       <entry>
        This function works only in the <literal>"cli"</literal> SAPI.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>
 
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <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>
 </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
-->
