[This is preliminary documentation and is subject to change.]
Creates a simple timer object under Modules/GHATimers node in the hierarchy. Timer is NOT started after creation.
Set the Enabled property to true to activate the timer
Namespace:
GHASchema.Helpers
Assembly:
GHASchema (in GHASchema.dll) Version: 1.1.8074.31450 (1.0.0.0)
Syntaxpublic static GHASimpleTimer AddTimer(
string name,
double interval,
Action action,
bool autoReset = false
)
Parameters
- name
- Type: SystemString
Name to give the timer - interval
- Type: SystemDouble
Time in milliseconds to wait before invoking the action - action
- Type: SystemAction
.NET Action delegate to execute when the interval has expired - autoReset (Optional)
- Type: SystemBoolean
If true, timer repeats the action every 'interval' milliseconds
Return Value
Type:
GHASimpleTimerObject reference to the newly added timer
See Also