xtd::forms::run_worker_completed_event_args Class Reference

Inheritance diagram for xtd::forms::run_worker_completed_event_args:

Definition

Provides data for the xtd::forms::background_worker::run_worker_completed event handler.

Header

#include <xtd/forms/run_wrker_completed_event_args>

Namespace

xtd::forms

Library

xtd.forms

Examples

background_worker.cpp.

Public Constructors
	run_worker_completed_event_args (const xtd::any_object &result, std::optional< std::reference_wrapper< std::exception > > exception, bool cancel)
	Initializes a new instance of the DoWorkEventArgs class.

Public Properties
bool	cancel () const noexcept
void	cancel (bool value)
xtd::any_object	user_state () const noexcept
	Gets a value that represents the argument of an asynchronous operation.
xtd::any_object	result () const noexcept

Additional Inherited Members
Static Public Attributes inherited from xtd::event_args
static const event_args	empty
	Provides a value to use with events that do not have event data.
Public Member Functions inherited from xtd::event_args
	event_args ()=default
	Initializes a new instance of the event_args class.
Public Member Functions inherited from xtd::object
	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::uptr< 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.
Static Public Member Functions inherited from xtd::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.

Constructor & Destructor Documentation

run_worker_completed_event_args()

xtd::forms::run_worker_completed_event_args::run_worker_completed_event_args ( const xtd::any_object &  result, std::optional< std::reference_wrapper< std::exception > >  exception, bool  cancel  )

inline

Initializes a new instance of the DoWorkEventArgs class.

Parameters

argument

Specifies an argument for an asynchronous operation.

Member Function Documentation

user_state()

xtd::any_object xtd::forms::run_worker_completed_event_args::user_state ( ) const

inlinenoexcept

Gets a value that represents the argument of an asynchronous operation.

Returns

An object representing the argument of an asynchronous operation.

---

The documentation for this class was generated from the following file:

• xtd.forms/include/xtd/forms/run_worker_completed_event_args.hpp