Home/ Manual/ win32service / functions/ win32_set_service_pause_resume_state

win32_set_service_pause_resume_state

PHP function Edit on GitHub ✎

Define or return the pause/resume capability for the current running service

Description

win32_set_service_pause_resume_state(bool $state = true): bool

If state parameter is provided, the pause/resume capability is changed.

Caution

This function work only in "cli" SAPI and in the Windows service running context. On other SAPI this function is disabled.

state: true for enable the service pause/resume capability. false for disable the service pause/resume capability.

Return the current or old pause/resume capability state.

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"

Version	Description
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.