<?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 => 'pt_BR',
  ),
  'this' => 
  array (
    0 => 'function.win32-set-service-status.php',
    1 => 'win32_set_service_status',
    2 => 'Atualiza o status do servi&ccedil;o',
  ),
  'up' => 
  array (
    0 => 'ref.win32service.php',
    1 => 'Fun&ccedil;&otilde;es de 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' => 'pt_BR',
    '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">Atualiza o status do serviço</span></p>

 </div>
 <div class="refsect1 description" id="refsect1-function.win32-set-service-status-description">
  <h3 class="title">Descrição</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">
   Informa ao GCS o status atual de um serviço em execução.
   Esta chamada só é válida para um processo de serviço em execução.
  </p>

  <div class="caution"><strong class="caution">Cuidado</strong>
   <p class="para">
    Desde a versão 0.2.0, esta função funciona somente no SAPI CLI. Em outros SAPI,
    esta função é desabilitada.
   </p>
  </div>

 </div>

 <div class="refsect1 parameters" id="refsect1-function.win32-set-service-status-parameters">
  <h3 class="title">Parâmetros</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">status</code></dt>
     <dd>
      <p class="para">
       O código de status do serviço, uma das constantes
       <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> ou
       <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">
       O valor do ponto de verificação que o serviço incrementa periodicamente para relatar seu
       progresso durante uma operação demorada de início, parada, pausa ou continuação.
       Por exemplo, o serviço deve incrementar esse valor à medida que conclui
       cada etapa de sua inicialização.
      </p>
      <p class="para">
       O parâmetro <code class="parameter">checkpoint</code> só é válido quando o parâmetro
       <code class="parameter">status</code> for uma das constantes
       <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> ou
       <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">Valor Retornado</h3>
  <p class="para">
   Nenhum valor é retornado.
  </p>
  <p class="para">
   Antes da versão 1.0.0, retornava <strong><code><a href="win32service.constants.php#constant.win32-no-error">WIN32_NO_ERROR</a></code></strong> em caso de sucesso, <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> se houver um problema com os parâmetros ou um <a href="win32service.constants.php#win32service.constants.errors" class="link">Código de Erro Win32</a> em caso de falha.
  </p>
 </div>


 <div class="refsect1 errors" id="refsect1-function.win32-set-service-status-errors">
  <h3 class="title">Erros/Exceções</h3>
  <p class="para">
   Antes da versão 1.0.0, se o SAPI não for <code class="literal">&quot;cli&quot;</code>, esta função emite um
   erro de nível <strong><code><a href="errorfunc.constants.php#constant.e-error">E_ERROR</a></code></strong>.
  </p>
  <p class="para">
   A partir da versão, lança uma exceção
   <span class="classname"><a href="class.win32serviceexception.php" class="classname">Win32ServiceException</a></span> se o SAPI não for
   <code class="literal">&quot;cli&quot;</code>.
  </p>
 </div>


 <div class="refsect1 changelog" id="refsect1-function.win32-set-service-status-changelog">
  <h3 class="title">Registro de Alterações</h3>
  <p class="para">
   <table class="doctable informaltable">
    
     <thead>
      <tr>
       <th>Versão</th>
       <th>Descrição</th>
      </tr>

     </thead>

     <tbody class="tbody">
      <tr>
       <td>PECL win32service 1.0.0</td>
       <td>
        Lança uma exceção <span class="classname"><a href="class.valueerror.php" class="classname">ValueError</a></span> em caso de dados inválidos nos parâmetros,
        anteriormente retornava <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>.
       </td>
      </tr>

      <tr>
       <td>PECL win32service 1.0.0</td>
       <td>
        Lança uma exceção <span class="classname"><a href="class.win32serviceexception.php" class="classname">Win32ServiceException</a></span> em caso de erro,
        anteriormente um
        <a href="win32service.constants.php#win32service.constants.errors" class="link">Código de Erro Win32</a>
        era retornado.
       </td>
      </tr>

      <tr>
       <td>PECL win32service 1.0.0</td>
       <td>
        O tipo de retorno agora é <span class="type"><span class="type"><a href="language.types.void.php" class="type void">void</a></span></span>, anteriormente era <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>
        Esta função funciona apenas no SAPI <code class="literal">&quot;cli&quot;</code>.
       </td>
      </tr>

     </tbody>
    
   </table>

  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.win32-set-service-status-seealso">
  <h3 class="title">Veja Também</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> - Registra o script no GCS, para que ele possa atuar como o servi&ccedil;o com o nome fornecido</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> - Retorna a &uacute;ltima mensagem de controle enviada para este servi&ccedil;o</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> - Define ou retorna o modo de sa&iacute;da do servi&ccedil;o em execu&ccedil;&atilde;o atual</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> - Define ou retorna o c&oacute;digo de sa&iacute;da do servi&ccedil;o em execu&ccedil;&atilde;o atual</span></li>
    <li><a href="win32service.constants.php#win32service.constants.servicestatus" class="link">Constantes de status do serviço Win32Service</a></li>
   </ul>
  </p>
 </div>


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