Name GetTimerInfo
Type Method
Summary Gets details about a timer
Prototype VARIANT GetTimerInfo(BSTR TimerName, short InfoType);
Description Gets details about the specified timer name.

You can obtain one of 10 "types" of information about the timer by specifying an "InfoType". The possible InfoTypes are:

1: The hour (short)
2: The minute (short)
3: The second (short)
4: What to send (string)
5: Script procedure name (string)
6: Enabled (boolean)
7: One shot timer (boolean)
8: "At" timer (if false, timer fires "every" hour/minute/second) (boolean)
9: Invocation count (long)
10: Times matched (long)
11: Date/time timer last fired (or was reset) (date)
12: Date/time timer will fire next (date)
13: Number of seconds until timer will fire next or zero if it is due to fire immediately (this might happen if the timer is due to fire but is disabled). (long)
14: 'temporary' flag (boolean)
15: 'speed walk' flag (boolean)
16: 'note' flag (boolean)
17: 'active when disconnected' flag (boolean)
18: Timer was included from an include file (boolean)


The word in brackets indicates the "type" of data returned.
String: a character string (eg. "north")
Boolean: TRUE or FALSE
Long: a 32-bit number

The field "invocation count" is a count of how many times the script routine was called.
The field "times matched" is a count of how many times the timer matched. These two would normally be the same, unless scripting was disabled, or there was an error in the script file.

If the named timer does not exist, EMPTY is returned. If the name given is invalid, NULL is returned. If the InfoType given is out of range, NULL is returned. (Use "IsEmpty" and "IsNull" to test for these possibilities).

See AddTimer for a description of the meanings of the fields.
VBscript example 
world.note world.GetTimerInfo ("my_timer", 2)
Jscript example 
world.note(world.GetTimerInfo ("my_timer", 2));
PerlScript example 
$world->note ($world->GetTimerInfo ("my_timer", 2));
Returns The specified information about the timer, as described above.
An EMPTY variant, if the timer does not exist.
A NULL variant if the timer name is invalid.
A NULL variant if the InfoType is not a valid type.

See also ...