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...

Inherits System::ComponentModel::AsyncCompletedEventArgs.

Public Member Functions

ASPOSECPP_SHARED_API RunWorkerCompletedEventArgs (const System::SharedPtr< System::Object > &result, const System::Exception &error, bool canceled)
 Constructor. More...
 
ASPOSECPP_SHARED_API System::SharedPtr< System::Objectget_Result () const
 Gets a value that represents the result of an asynchronous operation. More...
 
- Public Member Functions inherited from System::ComponentModel::AsyncCompletedEventArgs
ASPOSECPP_SHARED_API AsyncCompletedEventArgs ()
 Constructor. More...
 
ASPOSECPP_SHARED_API AsyncCompletedEventArgs (const System::Exception &error, bool canceled, const System::SharedPtr< System::Object > &userState)
 Initializes a new instance of the System.ComponentModel.AsyncCompletedEventArgs class. More...
 
ASPOSECPP_SHARED_API const System::Exceptionget_Error () const
 Gets a value indicating which error occurred during an asynchronous operation. More...
 
ASPOSECPP_SHARED_API 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...
 
ASPOSECPP_SHARED_API System::SharedPtr< Objectget_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
ASPOSECPP_SHARED_API EventArgs ()
 Constructor. More...
 
- Public Member Functions inherited from System::Object
ASPOSECPP_SHARED_API Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ASPOSECPP_SHARED_API ~Object ()
 Destroys object. Frees all internal data structures. More...
 
ASPOSECPP_SHARED_API Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 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...
 
ASPOSECPP_SHARED_API void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
ASPOSECPP_SHARED_API void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual ASPOSECPP_SHARED_API bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual ASPOSECPP_SHARED_API int32_t GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual ASPOSECPP_SHARED_API String ToString () const
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ASPOSECPP_SHARED_API ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual ASPOSECPP_SHARED_API const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual ASPOSECPP_SHARED_API bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual ASPOSECPP_SHARED_API 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 ASPOSECPP_SHARED_API bool FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
 For internal purposes only. 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...
 
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< Objectptr
 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 TypeInfoType ()
 Implements C# typeof(System.Object) construct. More...
 
- Static Public Attributes inherited from System::EventArgs
static ASPOSECPP_SHARED_API EventArgsPtr Empty
 A static member that represents an "empty" EventArgs shared pointer (null-pointer). More...
 
- Protected Member Functions inherited from System::ComponentModel::AsyncCompletedEventArgs
ASPOSECPP_SHARED_API 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()

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

Constructor.

Parameters
resultThe result of an asynchronous operation.
errorAny error that occurred during the asynchronous operation.
canceledA value indicating whether the asynchronous operation was canceled.

Member Function Documentation

◆ get_Result()

ASPOSECPP_SHARED_API 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.