timerinfo()

---

The timerinfo( function returns a dictionary that contains all of the properties of a timer.

---

Parameters

This function has one parameter:

name – name of the timer (must have been set up with the StartTimer statement).

---

Description

This function returns a dictionary that contains all of the properties of the specified timer. You can then use these functions to extract the property values:

• getdictionaryvalue( – use a key to retrieve an individual value from a dictionary
• listdictionarykeys( – list all of the keys within a dictionary
• dumpdictionary( – list all of the keys within a dictionary and their associated values

This example will display how many more times the alarm timer will run.

 local tinfo,truns,trepeats
 tinfo = timerinfo("alarms")
 truns = getdictionaryvalue(tinfo,"RunCount")
 trepeats = getdictionaryvalue(tinfo,"MaxCount")
 if trepeats = 0
     message "alarms will run forever"
 else
     message "alarms will run "+(trepeats-truns)+" more times."
 endif

---

Error Messages

timerinfo( function error: timer does not exist – There is no timer with the specified name

---

See Also

• appenddictionaryvalue -- appends a value to an item in a dictionary (see Data Dictionaries).
• changedictionaryname -- changes the name (key) of an item in a dictionary (see Data Dictionaries).
• changedictionaryvalues( -- changes one or more values in a dictionary (see Data Dictionaries).
• changetimer -- modifies a repeating task that will be performed periodically when Panorama is not otherwise busy.
• copypartialdictionary -- builds a new dictionary and initializes it with values from an existing dictionary (see Data Dictionaries).
• copypartialdictionary( -- partially copies a dictionary (see Data Dictionaries).
• Data Dictionaries -- Overview of Panorama's key/value data dictionaries.
• deletedictionaryvalue -- deletes a key/value pair from a dictionary (see Data Dictionaries).
• deletedictionaryvalue( -- deletes one or more key/value pairs from a dictionary (see Data Dictionaries).
• dictionarydifference -- builds an array that lists keys of dictionary values that are different between two dictionaries (see Data Dictionaries).
• dictionaryfromarray( -- builds a new dictionary and initializes it from a two dimensional text array (see Data Dictionaries and Text Arrays).
• dictionaryvalueexists -- returns true or false depending on whether or not a key/value pair exists in a dictionary (see Data Dictionaries).
• dictionaryvalueexists( -- returns true or false depending on whether or not a key/value pair exists in a dictionary (see Data Dictionaries).
• dumpdictionary -- returns a carriage return separated array of dictionary keys and values (see Data Dictionaries).
• dumpdictionary( -- returns a carriage return separated array of dictionary keys and values (see Data Dictionaries).
• dumpdictionaryquoted -- returns a carriage return separated array of dictionary keys and values (see Data Dictionaries).
• dumpdictionaryquoted( -- returns a carriage return separated array of dictionary keys and values (see Data Dictionaries). The text values are quoted.
• getdictionarykey -- returns the key of an item in the dictionary, given its value. This is essentially the opposite of the getdictionaryvalue( function (see Data Dictionaries).
• getdictionarykey( -- returns the key of an item in the dictionary, given its value). This is essentially the opposite of the getdictionaryvalue( function (see Data Dictionaries).
• getdictionaryvalue -- returns the value of an item in the dictionary, given its key (see Data Dictionaries).
• getdictionaryvalue( -- returns the value of an item in the dictionary, given its key (see Data Dictionaries).
• info("timerinfo") -- returns a dictionary that contains all of the properties of the currently running timer.
• info("timers") -- returns a carriage return separated list of all active timers.
• initializedictionary -- builds a new dictionary and initializes it with one or more key/value entries (see Data Dictionaries).
• initializedictionary( -- builds a new dictionary and initializes it with one or more key/value entries (see Data Dictionaries).
• initializedictionaryvalue( -- builds a new dictionary and initializes it with one or more entries (see Data Dictionaries). This function is deprecated, we recommend using the initializedictionary( function instead.
• listdictionarykeys( -- returns a list of the keys in a dictionary collection.
• listdictionarynames -- returns a list of the names (keys) in a dictionary (see Data Dictionaries).
• mergedictionaries -- merges the contents of two or more dictionaries (see Data Dictionaries).
• mergedictionaries( -- merges the contents of two or more dictionaries (see Data Dictionaries).
• renamedictionarykey( -- changes the key (name) of one or more values in a dictionary (see Data Dictionaries).
• setdictionaryvalue -- changes a value in a dictionary (see Data Dictionaries).
• starttimer -- sets up and starts a repeating task that will be performed periodically when Panorama is not otherwise busy.
• stoptimer -- stops and deletes a timer that was set up with the StartTimer statement.

---

History

Version	Status	Notes
10.0	New	New in this version.