FireDAC.Phys.TFDPhysEventThread Methods

From RAD Studio API Documentation
Jump to: navigation, search

InheritedProtected
AfterConstructionpublicExecutes the thread when the thread is created with CreateSuspended set to false.
BeforeDestructionpublic
CheckDisposedprotectedThis method is deprecated.
CheckTerminatedpublicIndicates whether the thread has been asked to terminate.
CheckThreadErrorprotectedChecks whether an error appears on a thread operation.
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.
Createpublic
CreateAnonymousThreadpublicCreates an instance of an internally derived thread.
DefaultHandlerpublicProvides the interface for a method that processes message records.
Destroypublic
DispatchpublicCalls message-handling methods for the object, based on the contents of the Message parameter.
DisposeOf (deprecated)publicDisposeOf forces the execution of the destructor code in an object.
DoActiveChangedprotected
DoAllowTerminateprotected
DoIdleprotected
DoTerminateprotectedGenerates an OnTerminate event.
DoTimeoutprotected
EnqueueMsgpublic
EqualspublicChecks whether the current instance and the Obj parameter are equal.
Executeprotected
FieldAddresspublicReturns the address of a published object field.
ForceQueuepublicQueues the execution of a method call within the main thread.
FreepublicDestroys an object and frees its associated memory, if necessary.
FreeInstancepublicDeallocates memory allocated by a previous call to the NewInstance method.
GetCPUUsagepublicCalculates the average time that the CPU is busy executing user code and kernel code.
GetDisposedprotectedGetter for the Disposed property.
GetHashCodepublicReturns an integer containing the hash code.
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.
GetStartMsgClassprotected
GetStopMsgClassprotected
GetSystemTimespublic
GetTerminateMsgClassprotected
GetTickCountpublicReturns the number of milliseconds that have elapsed since the system was started.
GetTickCount64public
InheritsFrompublicDetermines the relationship of two object types.
InitializeExternalThreadsListprotected
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.
IsTimeoutpublicReturns True if the specified ATimeout after AStartTime is passed.
MethodAddresspublicReturns the address of a class method by name.
MethodNamepublicReturns the name of a class method by address.
NameThreadForDebuggingpublicUse NameThreadForDebugging to name a thread that was created without a name. Also, use this method to rename a specified thread.
NewInstancepublicAllocates memory for an instance of an object type and returns a pointer to that new instance.
Pingpublic
QualifiedClassNamepublicReturns the qualified name of the class.
QueuepublicExecutes a method call within the main thread.
RemoveQueuedEventspublicRemove queued method calls.
Resume (deprecated)publicRestarts the execution of a suspended thread. Resume was intended to be used by debuggers and is deprecated in RAD Studio XE, in the year 2010.
SafeCallExceptionpublicHandles exceptions in methods declared using the safecall calling convention.
SetFreeOnTerminateprotected
SetReturnValuepublicSets the current thread's return value.
Shutdownpublic
ShutdownThreadprotected
SleeppublicSuspend the execution of the thread for a specified amount of time.
SpinWaitpublicBlocks the execution of the thread in a spin-wait loop.
StartpublicStarts the execution of a thread.
StaticQueue (deprecated)publicAsynchronously executes a method call within the main thread.
StaticSynchronize (deprecated)publicExecutes a method call within the main thread.
Suspend (deprecated)publicPauses a running thread. Suspend was intended to be used by debuggers and is deprecated in RAD Studio XE, in the year 2010.
Synchronizepublic
TerminatepublicSignals the thread to terminate by setting the Terminated property to true.
TerminatedSetprotected
ToStringpublicReturns a string containing the class name.
UnitNamepublicReturns the name of the unit where the class is defined.
UnitScopepublicReturns the class's unit scope.
WaitForpublicWaits for the thread to terminate and then returns the value of the ReturnValue property.
YieldpublicPasses the execution to another thread.