Provides data for the environment signal event. This class cannot be inherited.
- Namespace
- xtd
- Library
- xtd.core
- Examples:
- environment_cancel_signal.cpp.
|
bool | cancel () const noexcept |
| Gets a value that indicates whether a signal has interrupted the current process. The default is false, which terminates the current process. More...
|
|
void | cancel (bool cancel) |
| Sets a value that indicates whether a signal has interrupted the current process. The default is false, which terminates the current process. More...
|
|
xtd::signal | signal () const noexcept |
| Gets the signal that interrupted the current process. More...
|
|
◆ signal_cancel_event_args() [1/2]
xtd::signal_cancel_event_args::signal_cancel_event_args |
( |
| ) |
|
|
default |
◆ signal_cancel_event_args() [2/2]
xtd::signal_cancel_event_args::signal_cancel_event_args |
( |
xtd::signal |
signal | ) |
|
|
explicit |
Initializes a new instance of the signal_cancel_event_args class.
- Parameters
-
signal | One of the enumeration values that specifies the key combination that interrupted the current process. There is no default value.. |
◆ cancel() [1/2]
bool xtd::signal_cancel_event_args::cancel |
( |
| ) |
const |
|
noexcept |
Gets a value that indicates whether a signal has interrupted the current process. The default is false, which terminates the current process.
- Returns
- true if the current process should resume when the event handler concludes; false if the current process should terminate. The default value is false; the current process terminates when the event handler returns. If true, the current process continues.
◆ cancel() [2/2]
void xtd::signal_cancel_event_args::cancel |
( |
bool |
cancel | ) |
|
Sets a value that indicates whether a signal has interrupted the current process. The default is false, which terminates the current process.
- Parameters
-
true | if the current process should resume when the event handler concludes; false if the current process should terminate. The default value is false; the current process terminates when the event handler returns. If true, the current process continues. |
◆ signal()
xtd::signal xtd::signal_cancel_event_args::signal |
( |
| ) |
const |
|
noexcept |
Gets the signal that interrupted the current process.
- Returns
- One of the enumeration values that specifies the signal that interrupted the current process. There is no default value.
The documentation for this class was generated from the following file: