<?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-query-service-status.php',
    1 => 'win32_query_service_status',
    2 => 'Consulta o status de um servi&ccedil;o',
  ),
  'up' => 
  array (
    0 => 'ref.win32service.php',
    1 => 'Fun&ccedil;&otilde;es de 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' => 'pt_BR',
    '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">Consulta o status de um serviço</span></p>

 </div>
 <div class="refsect1 description" id="refsect1-function.win32-query-service-status-description">
  <h3 class="title">Descrição</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">
   Consulta o status atual de um serviço, retornando um array de
   informações.
  </p>

 </div>

 <div class="refsect1 parameters" id="refsect1-function.win32-query-service-status-parameters">
  <h3 class="title">Parâmetros</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">servicename</code></dt>
     <dd>
      <p class="para">
       O nome abreviado do serviço.
      </p>
     </dd>
    
    
     <dt><code class="parameter">machine</code></dt>
     <dd>
      <p class="para">
       O nome da máquina opcional. Se omitido, a máquina local será usada.
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.win32-query-service-status-returnvalues">
  <h3 class="title">Valor Retornado</h3>
  <p class="para">
   Retorna um array que consiste nas informações abaixo em caso de sucesso.
  </p>
  <p class="para">
   Antes da versão 1.0.0,, <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>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">ServiceType</code></dt>
     <dd>
      <p class="para">
       O tipo de serviço. Consulte as <a href="win32service.constants.php#win32service.constants.servicetype" class="link">Máscaras de bit de tipo de serviço do Win32Service</a>.
      </p>
     </dd>
    
    
     <dt><code class="parameter">CurrentState</code></dt>
     <dd>
      <p class="para">
       O status atual. Consulte as <a href="win32service.constants.php#win32service.constants.servicestatus" class="link">Constantes de status de serviço do Win32Service</a>.
      </p>
     </dd>
    
    
     <dt><code class="parameter">ControlsAccepted</code></dt>
     <dd>
      <p class="para">
       Quais controles de serviço são aceitos pelo serviço. Consulte as <a href="win32service.constants.php#win32service.constants.controlsaccepted" class="link">Máscaras de bits aceitas de mensagem de controle de serviço Win32Service</a>.
      </p>
     </dd>
    
    
     <dt><code class="parameter">Win32ExitCode</code></dt>
     <dd>
      <p class="para">
       Se o serviço foi encerrado, o código de retorno do processo. Este valor é igual a
       <strong><code><a href="win32service.constants.php#constant.win32-error-service-specific-error">WIN32_ERROR_SERVICE_SPECIFIC_ERROR</a></code></strong>
       se o modo de saída não for normal. Consulte os
       <a href="win32service.constants.php#win32service.constants.errors" class="link">códigos de erro do Win32Service</a> e
       a função <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">
       Se o serviço for encerrado com uma condição de erro, o código específico
       do serviço incluído no registro de eventos ficará visível aqui. Este valor é igual
       ao valor definido por <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">
       Se o serviço estiver sendo encerrado, contém o número do ponto de verificação atual.
       Isso é usado pelo GCS como uma espécie de pulsação para detectar um processo de
       serviço bloqueado.  O valor do ponto de verificação é melhor interpretado
       em conjunto com o valor WaitHint.
      </p>
     </dd>
    
    
     <dt><code class="parameter">WaitHint</code></dt>
     <dd>
      <p class="para">
       Se o serviço estiver sendo encerrado, ele definirá WaitHint para um valor
       de ponto de verificação que indicará 100% de conclusão. Isto pode ser usado para
       implementar um indicador de progresso.
      </p>
     </dd>
    
    
     <dt><code class="parameter">ProcessId</code></dt>
     <dd>
      <p class="para">
       O identificador de processo do Windows. Se for 0, o processo não está em execução.
      </p>
     </dd>
    
    
     <dt><code class="parameter">ServiceFlags</code></dt>
     <dd>
      <p class="para">
       As opções do serviço. Consulte as <a href="win32service.constants.php#win32service.constants.serviceflag" class="link">Constantes de opção de serviço do Win32Service</a>.
      </p>
     </dd>
    
   </dl>
  </p>

 </div>



 <div class="refsect1 errors" id="refsect1-function.win32-query-service-status-errors">
  <h3 class="title">Erros/Exceções</h3>
  <p class="para">
   Uma exceção <span class="classname"><a href="class.valueerror.php" class="classname">ValueError</a></span> será lançada se o
   valor do parâmetro <code class="parameter">servicename</code> estiver vazio.
  </p>
 </div>


 <div class="refsect1 changelog" id="refsect1-function.win32-query-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"><a href="language.types.array.php" class="type array">array</a></span>, anteriormente era <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">Veja Também</h3>
  <p class="para">
   <ul class="simplelist">
    <li><a href="win32service.constants.php" class="link">Constantes predefinidas Win32Service</a></li>
   </ul>
  </p>
 </div>


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