win32_set_service_status

(PECL win32service >=0.1.0)

win32_set_service_status — Update the service status

说明

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

Informs the SCM of the current status of a running service. This call is only valid for a running service process.

警告

Since version 0.2.0, this function work only in "cli" SAPI. On other SAPI this function is disabled.

参数

status

The service status code, one of 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

The checkpoint value the service increments periodically to report its progress during a lengthy start, stop, pause, or continue operation. For example, the service should increment this value as it completes each step of its initialization when it is starting up.

The checkpoint is only valid when the status is one of WIN32_SERVICE_STOP_PENDING, WIN32_SERVICE_START_PENDING, WIN32_SERVICE_CONTINUE_PENDING or WIN32_SERVICE_PAUSE_PENDING.

返回值

没有返回值。

Prior to version 1.0.0, 成功时返回 WIN32_NO_ERROR，参数错误时返回 false，或失败时返回一个 Win32 错误码。

错误／异常

Prior to version 1.0.0, if the SAPI is not "cli", this function emits an E_ERROR level error.

As of version 1.0.0, will throw a Win32ServiceException if SAPI is not "cli"

更新日志

版本 说明
PECL win32service 1.0.0 Throws a ValueError on invalid data in parameters, previously false was returned.
PECL win32service 1.0.0 Throws a Win32ServiceException on error, previously a Win32 Error Code was returned.
PECL win32service 1.0.0 The return type is now void, previously it was mixed.
PECL win32service 0.2.0 This function works only in the "cli" SAPI.

参见