System.Threading.TTask Methods

From RAD Studio API Documentation
Jump to: navigation, search


InheritedProtected
__MarkDestroyingprotected
_AddRefprotectedImplements the IInterface_AddRef method.
_ReleaseprotectedImplements the IInterface_Release method.
AddChildprotected
AddCompleteEventprotected
AfterConstructionpublicResponds after the last constructor executes.
BeforeDestructionpublicChecks that the reference count is zero before allowing the interfaced object to be destroyed.
CallUserCodeprotected
CancelprotectedCancels the task.
CheckCanceledprotectedChecks the task status. If the task is canceled, it raise and EOperationCancelled exception.
CheckDisposedprotected
CheckFaultedprotected
ClassInfopublicReturns a pointer to the run-time type information (RTTI) table for the object type.
ClassNamepublicReturns a string indicating the type of the object instance (as opposed to the type of the variable passed as an argument).
ClassNameIspublicDetermines whether an object is of a specific type.
ClassParentpublicReturns the type of the immediate ancestor of a class.
ClassTypepublicReturns the class reference for the object's class.
CleanupInstancepublicPerforms finalization on long strings, variants, and interface variables within a class.
Completeprotected
CreatepublicCreates an instance of TTask managing the execution of a procedure that may execute in a parallel thread.
CreateReplicaTaskprotected
CurrentTaskpublicCurrentTask returns an instance of ITask with the current task.
DefaultHandlerpublicProvides the interface for a method that processes message records.
DestroypublicDestroys this instance of TTask.
DispatchpublicCalls message-handling methods for the object, based on the contents of the Message parameter.
DisposeOfpublicDisposeOf forces the execution of the destructor code in an object.
DoWaitForAllprotectedDoWaitForAll pauses the calling task until an array of tasks finishes or the Timeout occurs.
DoWaitForAnyprotectedDoWaitForAny pauses the calling task until any of the tasks in the array finishes or the Timeout occurs.
EqualspublicChecks whether the current instance and the Obj parameter are equal.
Executeprotected
ExecuteReplicatesprotected
ExecuteWorkprotected
FieldAddresspublicReturns the address of a published object field.
FinalCompletionprotected
ForgetChildprotected
FreepublicDestroys an object and frees its associated memory, if necessary.
FreeInstancepublic
FuturepublicFuture accepts a function able to run in a parallel thread, returning an interface used to get the result at the point in the program that is needed.
GetControlFlagprotected
GetDisposedprotectedGetter for the Disposed property.
GetExceptionObjectprotected
GetHasExceptionsprotected
GetHashCodepublicReturns an integer containing the hash code.
GetIdprotectedReturns the unique interger ID.
GetInterfacepublicRetrieves a specified interface.
GetInterfaceEntrypublicReturns the entry for a specific interface implemented in a class.
GetInterfaceTablepublicReturns a pointer to a structure containing all of the interfaces implemented by a given class.
GetIsCanceledprotectedChecks the state of the task and returns True if it is canceled or False otherwise.
GetIsCompleteprotectedChecks the state of the task and returns True if it is completed or False otherwise.
GetIsQueuedprotectedChecks the state of the task and returns True if it is included in the queue of tasks or False otherwise.
GetIsReplicatingprotectedChecks the state of the task and returns True if it is a replica of other task or False otherwise.
GetStatusprotectedGetStatus obtains the Status of the calling task as a variable of type TTaskStatus.
GetWasExceptionRaisedprotectedChecks the state of the task and returns True if the task caused an exception or False otherwise.
HandleChildCompletionprotected
HandleExceptionprotected
InheritsFrompublicDetermines the relationship of two object types.
InitInstancepublicInitializes a newly allocated object instance to all zeros and initializes the instance's virtual method table pointer.
InstanceSizepublicReturns the size in bytes of each instance of the object type.
IntermediateCompletionprotected
InternalExecuteprotected
InternalExecuteNowprotected
InternalWorkprotected
MarkAsStartedprotectedAutomatically marks the task as having started. It returns True if the function successfully marks the task as having started. It returns False if the task has already been marked as started or the process has already been completed.
MethodAddresspublicReturns the address of a class method by name.
MethodNamepublicReturns the name of a class method by address.
NewIdprotectedReturns a non-zero unique integer Id.
NewInstancepublic
operator ()public
ProcessCompleteEventsprotected
QualifiedClassNamepublicReturns the qualified name of the class.
QueryInterfaceprotectedImplements the IInterfaceQueryInterface method.
QueueEventsprotected
RemoveCompleteEventprotected
RunpublicRun starts running a task and returns an instance of ITask.
SafeCallExceptionpublicHandles exceptions in methods declared using the safecall calling convention.
SetCompleteprotectedSets the state of the task to Completed if the task is finished.
SetExceptionObjectprotected
SetRaisedStateprotected
SetTaskStopprotected
ShouldCreateReplicaprotected
ShouldExecuteprotected
StartprotectedStart runs the calling task and returns an ITask instance of this task.
ToStringpublicReturns a string containing the class name.
TryExecuteNowprotected
UnitNamepublicReturns the name of the unit where the class is defined.
UnitScopepublicReturns the class's unit scope.
UpdateStateAtomicprotected
WaitprotectedImplements the wait function of ITask.
WaitForAllpublicWaitForAll calls DoWaitForAll, which waits for all the tasks in the array to be completed.
WaitForAnypublicWaitForAny calls DoWaitForAny, which waits for any of the tasks in the array to be completed.