win32_get_last_control_message
(PECL win32service >=0.1.0)
win32_get_last_control_message — Retorna a última mensagem de controle enviada para este serviço
Descrição
Retorna o código de controle enviado pela última vez para este processo de serviço. Ao executar como um serviço, isto deve ser verificado periodicamente para determinar se o serviço precisa parar de funcionar.
Desde a versão 0.2.0, esta função funciona somente no SAPI CLI. Em outros SAPI, esta função é desabilitada.
Parâmetros
Esta função não possui parâmetros.
Valor Retornado
Retorna uma constante de controle que será uma das
Constantes de mensagem de controle de serviço Win32Service:
WIN32_SERVICE_CONTROL_CONTINUE,
WIN32_SERVICE_CONTROL_DEVICEEVENT,
WIN32_SERVICE_CONTROL_HARDWAREPROFILECHANGE,
WIN32_SERVICE_CONTROL_INTERROGATE,
WIN32_SERVICE_CONTROL_NETBINDADD,
WIN32_SERVICE_CONTROL_NETBINDDISABLE,
WIN32_SERVICE_CONTROL_NETBINDENABLE,
WIN32_SERVICE_CONTROL_NETBINDREMOVE,
WIN32_SERVICE_CONTROL_PARAMCHANGE,
WIN32_SERVICE_CONTROL_PAUSE,
WIN32_SERVICE_CONTROL_POWEREVENT,
WIN32_SERVICE_CONTROL_PRESHUTDOWN,
WIN32_SERVICE_CONTROL_SESSIONCHANGE,
WIN32_SERVICE_CONTROL_SHUTDOWN,
WIN32_SERVICE_CONTROL_STOP.
Se o valor estiver entre 128 e 255, o código de controle é personalizado.
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 1.0.0, é lançada 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 0.2.0 |
Esta função funciona apenas no SAPI "cli".
|
Veja Também
- win32_start_service_ctrl_dispatcher() - Registra o script no GCS, para que ele possa atuar como o serviço com o nome fornecido
- win32_set_service_status() - Atualiza o status do serviço
- win32_set_service_exit_mode() - Define ou retorna o modo de saída do serviço em execução atual
- win32_set_service_exit_code() - Define ou retorna o código de saída do serviço em execução atual
- Constantes de mensagem de controle de serviço Win32Service