array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'en', ), 'this' => array ( 0 => 'function.win32-set-service-pause-resume-state.php', 1 => 'win32_set_service_pause_resume_state', 2 => 'Define or return the pause/resume capability for the current running service', ), 'up' => array ( 0 => 'ref.win32service.php', 1 => 'win32service Functions', ), 'prev' => array ( 0 => 'function.win32-set-service-exit-mode.php', 1 => 'win32_set_service_exit_mode', ), 'next' => array ( 0 => 'function.win32-set-service-status.php', 1 => 'win32_set_service_status', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'en', 'path' => 'reference/win32service/functions/win32-set-service-pause-resume-state.xml', ), 'history' => array ( ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); contributors($setup); ?>

win32_set_service_pause_resume_state

(PECL win32service >=1.1.0)

win32_set_service_pause_resume_state — 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.

Parameters

state

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

Return Values

Return the current or old pause/resume capability state.

Errors/Exceptions

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"

Changelog

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.

See Also