JVCL Help:TJvTimerList.Add

From Project JEDI Wiki
Jump to navigationJump to search
JEDI Visual Component Library Help

Search in JVCL Help

 
Search in all projects
 

Summary

Creates a new timer and adds it to the list.


Pascal

 functionAdd(AOnTimer: TNotifyEvent; AInterval: Longint; ACycled: Boolean): THandle; virtual;


Parameters

Parameters Description
AOnTimer: TNotifyEvent A TNotifyEvent procedure that will be called when the timer executes.
AInterval: Longint The interval in milliseconds between two executions for the added timer.
ACycled: Boolean Indicates whether the timer executes indefinitely or a specific number of times.


Return Value

Returns the handle of the added timer. This is not a windows handle. You can not use it in calls to windows API's. It is just a number that identifies a timer uniquely in a timer list.


Description

Add creates a timer and assigns the values passed in the AOnTimer, AInterval, and ACycled parameters to the TJvTimerEvent properties of the same names. Finally the timer is added to the timer list.


See Also

TJvTimerEvents.Add


About

Contribute to this help topic

This documentation wiki is based on the collaborative effort of Project JEDI users. Your edits are welcome in order to improve documentation quality: edit this page