win32_set_service_status

(PECL win32service >=0.1.0)

win32_set_service_statusОбновляет статус службы

Описание

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

Информирует SCM о текущем состоянии работающей службы. Этот вызов действителен только для запущенного сервисного процесса.

Предостережение

Начиная с версии 0.2.0, функция работает только в "cli" SAPI. На других SAPI эта функция отключена.

Список параметров

status

Код статуса службы, один из: WIN32_SERVICE_RUNNING, WIN32_SERVICE_STOPPED, WIN32_SERVICE_STOP_PENDING, WIN32_SERVICE_START_PENDING, WIN32_SERVICE_CONTINUE_PENDING, WIN32_SERVICE_PAUSE_PENDING, WIN32_SERVICE_PAUSED.

checkpoint

Значение контрольной точки, которое служба периодически увеличивает, чтобы сообщить о своём прогрессе во время длительного запуска, остановки, паузы или продолжения работы. Например, служба должна увеличивать это значение на единицу по мере завершения каждого шага своей инициализации при запуске.

checkpoint действительна только тогда, когда status является одним из WIN32_SERVICE_STOP_PENDING, WIN32_SERVICE_START_PENDING, WIN32_SERVICE_CONTINUE_PENDING или WIN32_SERVICE_PAUSE_PENDING.

Возвращаемые значения

Функция не возвращает значения после выполнения.

До версии 1.0.0, Функция возвращает WIN32_NO_ERROR в случае успешного завершения , false если обнаружилась проблема с параметрами, или код ошибки Win32 при неудачном завершении работы.

Ошибки

До версии 1.0.0, если SAPI не "cli", функция выдавала ошибку уровня E_ERROR.

Начиная с версии 1.0.0, выбрасывает Win32ServiceException, если SAPI не "cli"

Список изменений

Версия Описание
PECL win32service 1.0.0 Функция выбрасывает исключение ValueError при неверных данных в параметрах, раньше функция возвращала false.
PECL win32service 1.0.0 Функция выбрасывает исключение Win32ServiceException, если возникла ошибка, раньше функция возвращала Код ошибки Win32.
PECL win32service 1.0.0 Тип значения, которое возвращает функция, теперь void, раньше был mixed.
PECL win32service 0.2.0 Функция работает только с SAPI-интерфейсом cli.

Смотрите также