win32_query_service_status

(PECL win32service >=0.1.0)

win32_query_service_statusConsulta o status de um serviço

Descrição

win32_query_service_status(string $servicename, string $machine = null): array

Consulta o status atual de um serviço, retornando um array de informações.

Parâmetros

servicename

O nome abreviado do serviço.

machine

O nome da máquina opcional. Se omitido, a máquina local será usada.

Valor Retornado

Retorna um array que consiste nas informações abaixo em caso de sucesso.

Antes da versão 1.0.0,, false se houver um problema com os parâmetros ou um Código de Erro Win32 em caso de falha.

ServiceType

O tipo de serviço. Consulte as Máscaras de bit de tipo de serviço do Win32Service.

CurrentState

O status atual. Consulte as Constantes de status de serviço do Win32Service.

ControlsAccepted

Quais controles de serviço são aceitos pelo serviço. Consulte as Máscaras de bits aceitas de mensagem de controle de serviço Win32Service.

Win32ExitCode

Se o serviço foi encerrado, o código de retorno do processo. Este valor é igual a WIN32_ERROR_SERVICE_SPECIFIC_ERROR se o modo de saída não for normal. Consulte os códigos de erro do Win32Service e a função win32_set_service_exit_mode().

ServiceSpecificExitCode

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 win32_set_service_exit_code().

CheckPoint

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.

WaitHint

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.

ProcessId

O identificador de processo do Windows. Se for 0, o processo não está em execução.

ServiceFlags

As opções do serviço. Consulte as Constantes de opção de serviço do Win32Service.

Erros/Exceções

Uma exceção ValueError será lançada se o valor do parâmetro servicename estiver vazio.

Registro de Alterações

Versão Descrição
PECL win32service 1.0.0 Lança uma exceção ValueError em caso de dados inválidos nos parâmetros, anteriormente retornava false.
PECL win32service 1.0.0 Lança uma exceção Win32ServiceException em caso de erro, anteriormente um Código de Erro Win32 era retornado.
PECL win32service 1.0.0 O tipo de retorno agora é array, anteriormente era mixed.