win32_set_service_status

(PECL win32service >=0.1.0)

win32_set_service_status — Atualiza o status do serviço

Descrição

win32_set_service_status(int $status, int $checkpoint = 0): void

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.

Caution

Desde a versão 0.2.0, esta função funciona somente no SAPI CLI. Em outros SAPI, esta função é desabilitada.

Parâmetros

status

O código de status do serviço, uma das constantes WIN32_SERVICE_RUNNING, WIN32_SERVICE_STOPPED, WIN32_SERVICE_STOP_PENDING, WIN32_SERVICE_START_PENDING, WIN32_SERVICE_CONTINUE_PENDING, WIN32_SERVICE_PAUSE_PENDING ou WIN32_SERVICE_PAUSED.

checkpoint

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.

O parâmetro checkpoint só é válido quando o parâmetro status for uma das constantes WIN32_SERVICE_STOP_PENDING, WIN32_SERVICE_START_PENDING, WIN32_SERVICE_CONTINUE_PENDING ou WIN32_SERVICE_PAUSE_PENDING.

Valor Retornado

Nenhum valor é retornado.

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

Erros/Exceções

Antes da versão 1.0.0, se o SAPI não for "cli", esta função emite um erro de nível E_ERROR.

A partir da versão, lança uma exceção Win32ServiceException se o SAPI não for "cli".

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 é void, anteriormente era mixed.
PECL win32service 0.2.0 Esta função funciona apenas no SAPI "cli".

Veja Também