Sign in Join
FPDoc Onlineexperiment

TWidgetSet.DestroyTimer function

Member of TWidgetSetpublicIn unit InterfaceBase

Destroys the timer with the specified handle.

Declaration

pascal
function DestroyTimer(TimerHandle: TLCLHandle): Boolean; virtual
 ; abstract

Arguments

TimerHandle

Handle (or ID) for the timer destroyed in the method.

Function result

True if the timer was successfully destroyed. False on failure.

Description

Declared as an abstract virtual method in TWidgetSet. Must be implemented in a descendent class to use the platform-specific mechanism(s) required for the implementation.

Modified in LCL version 4.0 to use the TLCLHandle type instead of the deprecated THandle type in the TimerHandle parameter.

See also

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.