win32-query-service-status.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. -->
<refentry xml:id="function.win32-query-service-status" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>win32_query_service_status</refname>
  <refpurpose>Queries the status of a service</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>win32_query_service_status</methodname>
   <methodparam><type>string</type><parameter>servicename</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>machine</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>

  <para>
   Queries the current status for a service, returning an array of
   information.
  </para>

 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>servicename</parameter></term>
     <listitem>
      <para>
       The short name of the service.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>machine</parameter></term>
     <listitem>
      <para>
       The optional machine name.  If omitted, the local machine will be used.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns an array consisting of the following information on success
  </para>
  <para>
    Prior version 1.0.0&win32service.false.error;
  </para>
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>ServiceType</parameter></term>
     <listitem>
      <para>
       The dwServiceType. See <link linkend="win32service.constants.servicetype">Win32Service Service Type Bitmasks</link>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>CurrentState</parameter></term>
     <listitem>
      <para>
       The dwCurrentState. See <link linkend="win32service.constants.servicestatus">Win32Service Service Status Constants</link>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>ControlsAccepted</parameter></term>
     <listitem>
      <para>
       Which service controls are accepted by the service. See <link linkend="win32service.constants.controlsaccepted">Win32Service Service Control Message Accepted Bitmasks</link>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>Win32ExitCode</parameter></term>
     <listitem>
      <para>
       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 
       <function>win32_set_service_exit_mode</function>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>ServiceSpecificExitCode</parameter></term>
     <listitem>
      <para>
       If the service exited with an error condition, the service specific
       code that is logged in the event log is visible here. This value is equal 
       to the value defined by <function>win32_set_service_exit_code</function>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>CheckPoint</parameter></term>
     <listitem>
      <para>
       If the service is shutting down, holds the current check point number.
       This is used by the SCM as a kind of heart-beat to detect a wedged service
       process.  The value of the check point is best interpreted in
       conjunction with the WaitHint value.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>WaitHint</parameter></term>
     <listitem>
      <para>
       If the service is shutting down it will set WaitHint to a checkpoint
       value that will indicate 100% completion.  This can be used to
       implement a progress indicator.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>ProcessId</parameter></term>
     <listitem>
      <para>
       The Windows process identifier. If 0, the process is not running.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>ServiceFlags</parameter></term>
     <listitem>
      <para>
       The dwServiceFlags. See <link linkend="win32service.constants.serviceflag">Win32Service Service Flag Constants</link>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>

 </refsect1>


 <refsect1 role="errors"><!-- {{{ -->
  &reftitle.errors;
  <para>
    A <classname>ValueError</classname> is thrown if the
    value of <parameter>servicename</parameter> parameter is empty.
  </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>array</type>, previously it was <type>mixed</type>.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1><!-- }}} -->

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><link linkend="win32service.constants">Win32Service Predefined 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
-->