Provides data for the environment signal event. This class cannot be inherited.
true
in the event handler, the process is resumed; otherwise, the process is terminated. By default, the value of the signal_cancel_event_args property is false
, and the process terminates. Public Constructors | |
signal_cancel_event_args ()=default | |
Initializes a new instance of the signal_cancel_event_args class. | |
signal_cancel_event_args (xtd::signal signal) | |
Initializes a new instance of the signal_cancel_event_args class. | |
Public Properties | |
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. | |
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. | |
xtd::signal | signal () const noexcept |
Gets the signal that interrupted the current process. | |
Additional Inherited Members | |
static const event_args | empty |
Provides a value to use with events that do not have event data. | |
event_args ()=default | |
Initializes a new instance of the event_args class. | |
object ()=default | |
Create a new instance of the ultimate base class object. | |
virtual bool | equals (const object &obj) const noexcept |
Determines whether the specified object is equal to the current object. | |
virtual xtd::size | get_hash_code () const noexcept |
Serves as a hash function for a particular type. | |
virtual type_object | get_type () const noexcept |
Gets the type of the current instance. | |
template<class object_t> | |
xtd::unique_ptr_object< object_t > | memberwise_clone () const |
Creates a shallow copy of the current object. | |
virtual xtd::string | to_string () const noexcept |
Returns a xtd::string that represents the current object. | |
template<class object_a_t, class object_b_t> | |
static bool | equals (const object_a_t &object_a, const object_b_t &object_b) noexcept |
Determines whether the specified object instances are considered equal. | |
template<class object_a_t, class object_b_t> | |
static bool | reference_equals (const object_a_t &object_a, const object_b_t &object_b) noexcept |
Determines whether the specified object instances are the same instance. | |
|
default |
Initializes a new instance of the signal_cancel_event_args class.
|
explicit |
Initializes a new instance of the signal_cancel_event_args class.
signal | One of the enumeration values that specifies the key combination that interrupted the current process. There is no default value.. |
|
noexcept |
Gets a value that indicates whether a signal has interrupted the current process. The default is false
, which terminates the current process.
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. 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.
cancel | 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. |
|
noexcept |
Gets the signal that interrupted the current process.