System::ComponentModel::RunWorkerCompletedEventArgs Class Reference

An instance of this class is passed as the argument to the RunWorkerCompletedEventHandler delegate. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument. More...

#include <run_worker_completed_event_args.h>

Inherits System::ComponentModel::AsyncCompletedEventArgs.

Public Member Functions
	RunWorkerCompletedEventArgs (const System::SharedPtr< System::Object > &result, const System::Exception &error, bool canceled)
	Constructor. More...
System::SharedPtr< System::Object >	get_Result () const
	Gets a value that represents the result of an asynchronous operation. More...
Public Member Functions inherited from System::ComponentModel::AsyncCompletedEventArgs
	AsyncCompletedEventArgs ()
	Constructor. More...
	AsyncCompletedEventArgs (const System::Exception &error, bool canceled, const System::SharedPtr< System::Object > &userState)
	Initializes a new instance of the System.ComponentModel.AsyncCompletedEventArgs class. More...
const System::Exception &	get_Error () const
	Gets a value indicating which error occurred during an asynchronous operation. More...
bool	get_Cancelled () const
	Gets a value indicating whether an asynchronous operation has been canceled. true if the background operation has been canceled; otherwise false. The default is false. More...
System::SharedPtr< Object >	get_UserState () const
	Gets the unique identifier for the asynchronous task. An object reference that uniquely identifies the asynchronous task; otherwise, null if no value has been set. More...
Public Member Functions inherited from System::EventArgs
	EventArgs ()
	Constructor. More...
Public Member Functions inherited from System::Object
	Object ()
	Creates object. Initializes all internal data structures. More...
virtual	~Object ()
	Destroys object. Frees all internal data structures. More...
	Object (Object const &x)
	Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
Object &	operator= (Object const &x)
	Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
Object *	SharedRefAdded ()
	Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
int	SharedRefRemovedSafe ()
	Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
int	RemovedSharedRefs (int count)
	Decreases shared reference count by specified value. More...
Detail::SmartPtrCounter *	WeakRefAdded ()
	Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
void	WeakRefRemoved ()
	Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
Detail::SmartPtrCounter *	GetCounter ()
	Gets reference counter data structure associated with the object. More...
int	SharedCount () const
	Gets current value of shared reference counter. More...
void	Lock ()
	Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
void	Unlock ()
	Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
virtual bool	Equals (ptr obj)
	Compares objects using C# Object.Equals semantics. More...
virtual int32_t	GetHashCode () const
	Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
virtual String	ToString () const
	Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
virtual ptr	MemberwiseClone () const
	Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
virtual const TypeInfo &	GetType () const
	Gets actual type of object. Analog of C# System.Object.GetType() call. More...
virtual bool	Is (const TypeInfo &targetType) const
	Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
virtual void	SetTemplateWeakPtr (uint32_t argument)
	Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
virtual bool	FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
	For internal purposes only. More...
template<>
bool	ReferenceEquals (String const &str, std::nullptr_t)
	Specialization of Object::ReferenceEquals for case of string and nullptr. More...
template<>
bool	ReferenceEquals (String const &str1, String const &str2)
	Specialization of Object::ReferenceEquals for case of strings. More...

Additional Inherited Members
Public Types inherited from System::Object
typedef SmartPtr< Object >	ptr
	Alias for smart pointer type. More...
Static Public Member Functions inherited from System::Object
static bool	ReferenceEquals (ptr const &objA, ptr const &objB)
	Compares objects by reference. More...
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type	ReferenceEquals (T const &objA, T const &objB)
	Compares objects by reference. More...
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type	ReferenceEquals (T const &objA, std::nullptr_t)
	Reference-compares value type object with nullptr. More...
template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type	Equals (T1 const &objA, T2 const &objB)
	Compares reference type objects in C# style. More...
template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type	Equals (T1 const &objA, T2 const &objB)
	Compares value type objects in C# style. More...
static const TypeInfo &	Type ()
	Implements C# typeof(System.Object) construct. More...
template<>
bool	Equals (float const &objA, float const &objB)
	Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
template<>
bool	Equals (double const &objA, double const &objB)
	Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
Static Public Attributes inherited from System::EventArgs
static EventArgsPtr	Empty
	A static member that represents an "empty" EventArgs shared pointer (null-pointer). More...
Protected Member Functions inherited from System::ComponentModel::AsyncCompletedEventArgs
void	RaiseExceptionIfNecessary ()

Detailed Description

An instance of this class is passed as the argument to the RunWorkerCompletedEventHandler delegate. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument.

Constructor & Destructor Documentation

RunWorkerCompletedEventArgs()

System::ComponentModel::RunWorkerCompletedEventArgs::RunWorkerCompletedEventArgs	(	const System::SharedPtr< System::Object > &	result,
		const System::Exception &	error,
		bool	canceled
	)

Constructor.

Parameters

result	The result of an asynchronous operation.
error	Any error that occurred during the asynchronous operation.
canceled	A value indicating whether the asynchronous operation was canceled.

Member Function Documentation

get_Result()

System::SharedPtr< System::Object > System::ComponentModel::RunWorkerCompletedEventArgs::get_Result

(

)

const

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

Returns

An System.Object representing the result of an asynchronous operation.