win32_set_service_status

(PECL win32service >=0.1.0)

win32_set_service_statusUpdate the service status

Description

win32_set_service_status ( int $status [, int $checkpoint = 0 ] ) : bool

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

Caution

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

Parameters

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.

Return Values

Returns TRUE on success, FALSE if there is a problem with the parameters or a Win32 Error Code on failure.

Errors/Exceptions

If SAPI is not "cli", this function emits an E_ERROR level error.

Changelog

Version Description
0.2.0 This function works only in the "cli" SAPI.

See Also