<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.win32service.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ru',
  ),
  'this' => 
  array (
    0 => 'function.win32-query-service-status.php',
    1 => 'win32_query_service_status',
    2 => 'Запрашивает статус службы',
  ),
  'up' => 
  array (
    0 => 'ref.win32service.php',
    1 => 'win32service',
  ),
  'prev' => 
  array (
    0 => 'function.win32-pause-service.php',
    1 => 'win32_pause_service',
  ),
  'next' => 
  array (
    0 => 'function.win32-read-all-rights-access-service.php',
    1 => 'win32_read_all_rights_access_service',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ru',
    'path' => 'reference/win32service/functions/win32-query-service-status.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.win32-query-service-status" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">win32_query_service_status</h1>
  <p class="verinfo">(PECL win32service &gt;=0.1.0)</p><p class="refpurpose"><span class="refname">win32_query_service_status</span> &mdash; <span class="dc-title">Запрашивает статус службы</span></p>

 </div>
 <div class="refsect1 description" id="refsect1-function.win32-query-service-status-description">
  <h3 class="title">Описание</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>win32_query_service_status</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$servicename</code></span>, <span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$machine</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></span>): <span class="type"><a href="language.types.array.php" class="type array">array</a></span></div>


  <p class="para rdfs-comment">
   Функция запрашивает текущий статус службы и возвращает массив информации.
  </p>

 </div>

 <div class="refsect1 parameters" id="refsect1-function.win32-query-service-status-parameters">
  <h3 class="title">Список параметров</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">servicename</code></dt>
     <dd>
      <p class="para">
       Краткое название службы.
      </p>
     </dd>
    
    
     <dt><code class="parameter">machine</code></dt>
     <dd>
      <p class="para">
       Необязательное имя машины. Функция работает с локальной машиной, если параметр не установили.
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.win32-query-service-status-returnvalues">
  <h3 class="title">Возвращаемые значения</h3>
  <p class="para">
   В случае успешного выполнения функция возвращает массив, который состоит из следующей информации:
  </p>
  <p class="para">
    До версии 1.0.0 , <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>, если возникла проблема с параметрами,
или <a href="win32service.constants.php#win32service.constants.errors" class="link">
код ошибки Win32</a>, если возникла ошибка.
  </p>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">ServiceType</code></dt>
     <dd>
      <p class="para">
       Тип dwServiceType. Смотрите
       <a href="win32service.constants.php#win32service.constants.servicetype" class="link">Битовые маски типов службы Win32Service</a>.
      </p>
     </dd>
    
    
     <dt><code class="parameter">CurrentState</code></dt>
     <dd>
      <p class="para">
       Тип dwCurrentState. Смотрите
       <a href="win32service.constants.php#win32service.constants.servicestatus" class="link">Константы состояния службы Win32Service</a>.
      </p>
     </dd>
    
    
     <dt><code class="parameter">ControlsAccepted</code></dt>
     <dd>
      <p class="para">
       Какие элементы управления службами принимаются службой. Смотрите
       <a href="win32service.constants.php#win32service.constants.controlsaccepted" class="link">Битовые маски принятых управляющих сообщений службы Win32Service</a>.
      </p>
     </dd>
    
    
     <dt><code class="parameter">Win32ExitCode</code></dt>
     <dd>
      <p class="para">
       Код возврата из процесса, если служба завершила работу.
       Это значение равно <strong><code><a href="win32service.constants.php#constant.win32-error-service-specific-error">WIN32_ERROR_SERVICE_SPECIFIC_ERROR</a></code></strong>,
       если режим выхода не плавный. Смотрите
       <a href="win32service.constants.php#win32service.constants.errors" class="link">коды ошибок Win32Service</a>
       и описание функции <span class="function"><a href="function.win32-set-service-exit-mode.php" class="function">win32_set_service_exit_mode()</a></span>.
      </p>
     </dd>
    
    
     <dt><code class="parameter">ServiceSpecificExitCode</code></dt>
     <dd>
      <p class="para">
       Код конкретной службы, который ОС зарегистрировала в журнале событий
       при завершении работы службы. Это значение равно значению,
       которое определили функцией <span class="function"><a href="function.win32-set-service-exit-code.php" class="function">win32_set_service_exit_code()</a></span>
      </p>
     </dd>
    
    
     <dt><code class="parameter">CheckPoint</code></dt>
     <dd>
      <p class="para">
       Текущий номер контрольной точки, если служба завершила работу.
       Значением пользуется БС SCM как сердцебиением, чтобы обнаружить заклинивание процесса обслуживания.
       Значение контрольной точки лучше всего интерпретировать вместе со значением WaitHint.
      </p>
     </dd>
    
    
     <dt><code class="parameter">WaitHint</code></dt>
     <dd>
      <p class="para">
       Служба установит для WaitHint значение контрольной точки,
       которое будет указывать на 100 % завершение, если служба завершила работу.
       Значением пользуются для реализации индикатора прогресса.
      </p>
     </dd>
    
    
     <dt><code class="parameter">ProcessId</code></dt>
     <dd>
      <p class="para">
       Идентификатор процесса Windows. Для незапущенных процессов значение параметра равняется 0.
      </p>
     </dd>
    
    
     <dt><code class="parameter">ServiceFlags</code></dt>
     <dd>
      <p class="para">
       Тип dwServiceFlags. Смотрите <a href="win32service.constants.php#win32service.constants.serviceflag" class="link">Константы флагов службы Win32Service</a>.
      </p>
     </dd>
    
   </dl>
  </p>

 </div>



 <div class="refsect1 errors" id="refsect1-function.win32-query-service-status-errors">
  <h3 class="title">Ошибки</h3>
  <p class="para">
    Функция выбрасывает исключение <span class="classname"><a href="class.valueerror.php" class="classname">ValueError</a></span>,
    если значение параметра <code class="parameter">servicename</code> не указали.
  </p>
 </div>


 <div class="refsect1 changelog" id="refsect1-function.win32-query-service-status-changelog">
  <h3 class="title">Список изменений</h3>
  <p class="para">
   <table class="doctable informaltable">
    
     <thead>
      <tr>
       <th>Версия</th>
       <th>Описание</th>
      </tr>

     </thead>

     <tbody class="tbody">
      <tr>
       <td>PECL win32service 1.0.0</td>
       <td>
        Функция выбрасывает исключение <span class="classname"><a href="class.valueerror.php" class="classname">ValueError</a></span> при недопустимых данных в параметрах,
        раньше возвращалось <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>.
       </td>
      </tr>

      <tr>
       <td>PECL win32service 1.0.0</td>
       <td>
        Функция выбрасывает исключение <span class="classname"><a href="class.win32serviceexception.php" class="classname">Win32ServiceException</a></span>, если возникла ошибка,
        раньше возвращался
        <a href="win32service.constants.php#win32service.constants.errors" class="link">Код ошибки Win32</a>.
       </td>
      </tr>

      <tr>
       <td>PECL win32service 1.0.0</td>
       <td>
        Тип возврата теперь <span class="type"><a href="language.types.array.php" class="type array">array</a></span>, раньше был <span class="type"><a href="language.types.mixed.php" class="type mixed">mixed</a></span>.
       </td>
      </tr>

     </tbody>
    
   </table>

  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.win32-query-service-status-seealso">
  <h3 class="title">Смотрите также</h3>
  <p class="para">
   <ul class="simplelist">
    <li><a href="win32service.constants.php" class="link">Предопределённые константы Win32Service</a></li>
   </ul>
  </p>
 </div>


</div><?php manual_footer($setup); ?>