<?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-set-service-status.php',
    1 => 'win32_set_service_status',
    2 => 'Обновляет статус службы',
  ),
  'up' => 
  array (
    0 => 'ref.win32service.php',
    1 => 'win32service',
  ),
  'prev' => 
  array (
    0 => 'function.win32-set-service-pause-resume-state.php',
    1 => 'win32_set_service_pause_resume_state',
  ),
  'next' => 
  array (
    0 => 'function.win32-start-service.php',
    1 => 'win32_start_service',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ru',
    'path' => 'reference/win32service/functions/win32-set-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-set-service-status" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">win32_set_service_status</h1>
  <p class="verinfo">(PECL win32service &gt;=0.1.0)</p><p class="refpurpose"><span class="refname">win32_set_service_status</span> &mdash; <span class="dc-title">Обновляет статус службы</span></p>

 </div>
 <div class="refsect1 description" id="refsect1-function.win32-set-service-status-description">
  <h3 class="title">Описание</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>win32_set_service_status</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$status</code></span>, <span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$checkpoint</code><span class="initializer"> = 0</span></span>): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>

  <p class="para rdfs-comment">
   Информирует SCM о текущем состоянии работающей службы.
   Этот вызов действителен только для запущенного сервисного процесса.
  </p>

  <div class="caution"><strong class="caution">Предостережение</strong>
   <p class="para">
    С версии 0.2.0 функция работает только через SAPI-интерфейс CLI.
    Через другие SAPI-интерфейсы функция не работает.
   </p>
  </div>

 </div>

 <div class="refsect1 parameters" id="refsect1-function.win32-set-service-status-parameters">
  <h3 class="title">Список параметров</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">status</code></dt>
     <dd>
      <p class="para">
       Код статуса службы из списка:
       <strong><code><a href="win32service.constants.php#constant.win32-service-running">WIN32_SERVICE_RUNNING</a></code></strong>,
       <strong><code><a href="win32service.constants.php#constant.win32-service-stopped">WIN32_SERVICE_STOPPED</a></code></strong>,
       <strong><code><a href="win32service.constants.php#constant.win32-service-stop-pending">WIN32_SERVICE_STOP_PENDING</a></code></strong>,
       <strong><code><a href="win32service.constants.php#constant.win32-service-start-pending">WIN32_SERVICE_START_PENDING</a></code></strong>,
       <strong><code><a href="win32service.constants.php#constant.win32-service-continue-pending">WIN32_SERVICE_CONTINUE_PENDING</a></code></strong>,
       <strong><code><a href="win32service.constants.php#constant.win32-service-pause-pending">WIN32_SERVICE_PAUSE_PENDING</a></code></strong>,
       <strong><code><a href="win32service.constants.php#constant.win32-service-paused">WIN32_SERVICE_PAUSED</a></code></strong>.
      </p>
     </dd>
    
    
     <dt><code class="parameter">checkpoint</code></dt>
     <dd>
      <p class="para">
       Значение контрольной точки, которое служба периодически увеличивает,
       чтобы сообщить о своём прогрессе во время длительного запуска, остановки,
       паузы или продолжения работы. Например, служба должна увеличивать это значение
       на единицу по мере завершения каждого шага своей инициализации при запуске.
      </p>
      <p class="para">
       Контрольная точка <code class="parameter">checkpoint</code> действительна, только если
       статус <code class="parameter">status</code> равен значению из списка:
       <strong><code><a href="win32service.constants.php#constant.win32-service-stop-pending">WIN32_SERVICE_STOP_PENDING</a></code></strong>,
       <strong><code><a href="win32service.constants.php#constant.win32-service-start-pending">WIN32_SERVICE_START_PENDING</a></code></strong>,
       <strong><code><a href="win32service.constants.php#constant.win32-service-continue-pending">WIN32_SERVICE_CONTINUE_PENDING</a></code></strong>
       или <strong><code><a href="win32service.constants.php#constant.win32-service-pause-pending">WIN32_SERVICE_PAUSE_PENDING</a></code></strong>.
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.win32-set-service-status-returnvalues">
  <h3 class="title">Возвращаемые значения</h3>
  <p class="para">
   Функция не возвращает значения после выполнения.
  </p>
  <p class="para">
    До версии 1.0.0, Функция возвращает
<strong><code><a href="win32service.constants.php#constant.win32-no-error">WIN32_NO_ERROR</a></code></strong>
в случае успешного завершения , <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>
 </div>


 <div class="refsect1 errors" id="refsect1-function.win32-set-service-status-errors">
  <h3 class="title">Ошибки</h3>
  <p class="para">
   До версии 1.0.0 при вызове не через SAPI-интерфейс <code class="literal">CLI</code>
   функция выдаёт ошибку уровня <strong><code><a href="errorfunc.constants.php#constant.e-error">E_ERROR</a></code></strong>.
  </p>
   <p class="para">
    С версии 1.0.0 при вызове не через SAPI-интерфейс CLI
    функция выбрасывает исключение <span class="classname"><a href="class.win32serviceexception.php" class="classname">Win32ServiceException</a></span>.
   </p>
 </div>


 <div class="refsect1 changelog" id="refsect1-function.win32-set-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"><span class="type"><a href="language.types.void.php" class="type void">void</a></span></span>, раньше был <span class="type"><a href="language.types.mixed.php" class="type mixed">mixed</a></span>.
       </td>
      </tr>

      <tr>
       <td>PECL win32service 0.2.0</td>
       <td>
        Функция работает только с SAPI-интерфейсом <code class="literal">CLI</code>.
       </td>
      </tr>

     </tbody>
    
   </table>

  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.win32-set-service-status-seealso">
  <h3 class="title">Смотрите также</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.win32-start-service-ctrl-dispatcher.php" class="function" rel="rdfs-seeAlso">win32_start_service_ctrl_dispatcher()</a> - Регистрирует скрипт в Диспетчере управления службами, чтобы он действовал как служба с заданным именем</span></li>
    <li><span class="function"><a href="function.win32-get-last-control-message.php" class="function" rel="rdfs-seeAlso">win32_get_last_control_message()</a> - Возвращает последнее управляющее сообщение, которое отправили этой службе</span></li>
    <li><span class="function"><a href="function.win32-set-service-exit-mode.php" class="function" rel="rdfs-seeAlso">win32_set_service_exit_mode()</a> - Определяет или возвращает режим выхода для текущей запущенной службы</span></li>
    <li><span class="function"><a href="function.win32-set-service-exit-code.php" class="function" rel="rdfs-seeAlso">win32_set_service_exit_code()</a> - Определяет или возвращает код выхода для текущей запущенной службы</span></li>
    <li><a href="win32service.constants.php#win32service.constants.servicestatus" class="link">Константы состояния службы Win32Service</a></li>
   </ul>
  </p>
 </div>


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