System.Classes.TThread.CheckTerminated

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

class function CheckTerminated: Boolean; static;

C++

static bool __fastcall CheckTerminated();

Properties

Type Visibility Source Unit Parent
function public
System.Classes.pas
System.Classes.hpp
System.Classes TThread

Description

Indicates whether the thread has been asked to terminate.

Use CheckTerminated to check whether the Terminated flag has been set on the current thread.

This class function returns the same value as the Terminated property, only that you can call CheckTerminated from outside the thread class. From within the thread class, use Terminated instead, as its performance is slightly better.

Note: You can only call CheckTerminated and SetReturnValue on an internally created thread. Calling this on an externally created thread will raise an exception.

See Also