JVCL Help:TJvAlarms.Add

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

Search in JVCL Help

 
Search in all projects
 

Summary

Adds a new alarm.


Pascal

 procedureAdd(constAName: string; constATime: TDateTime; constAKind: TJvTriggerKind = tkOneShot);


Parameters

Parameters Description
const AName: string Name of the alarm. The name is the only way you can identify an alarm during an OnAlarm event.
const ATime: TDateTime Date and time at which the alarm should go off.
const AKind: TJvTriggerKind = tkOneShot The kind of alarm to be added. Kind will default to tkOneShot, meaning that the alarm will fire only once and at the specified time.


Description

Add adds a new alarm to the component. To add an alarm you need to provide a name (the alarm's ID), a date/time when the alarm should fire and the kind of alarm (default's to one-shot).


See Also

TJvAlarms.Alarms, TJvAlarms.Delete, TJvAlarms.OnAlarm, TJvTriggerKind


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