sapi_windows_set_ctrl_handler

PHP 7 >= 7.4.0, PHP 8
sapi_windows_set_ctrl_handler - Set or remove a CTRL event handler
Manual
Code Examples

sapi_windows_set_ctrl_handler( callable|null$handler, [bool$add = true] ): bool

Sets or removes a CTRL event handler, which allows Windows CLI processes to intercept or ignore CTRL+C and CTRL+BREAK events. Note that in multithreaded environments, this is only possible when called from the main thread.

Parameters

handler

A callback function to set or remove. If set, this function will be called whenever a CTRL+C or CTRL+BREAK event occurs. The function is supposed to have the following signature:

handler( int$event ): void
event

The CTRL event which has been received; either PHP_WINDOWS_EVENT_CTRL_C or PHP_WINDOWS_EVENT_CTRL_BREAK.

Setting a null handler causes the process to ignore CTRL+C events, but not CTRL+BREAK events.

add

If true, the handler is set. If false, the handler is removed.

Return Values

Returns true on success or false on failure.

Related Functions

Example of sapi_windows_set_ctrl_handler

Show all examples for sapi_windows_set_ctrl_handler

PHP Version:


Function sapi_windows_set_ctrl_handler:

Miscellaneous Functions Functions

Most used PHP functions