8: TSP command reference Model 2450 Interactive SourceMeter® Instrument
8-250 2450-901-01 Rev. B/September 2013
Example
userstring.add("assetnumber", "236")
userstring.add("product", "Widgets")
userstring.add("contact", "John Doe")
for name in userstring.catalog() do
print(name .. " = " ..
userstring.get(name))
Stores user-defined strings in nonvolatile
memory and recalls them from the
instrument using a for loop.
Also see
userstring.catalog() (on page 8-250)
userstring.delete() (on page 8-251)
userstring.get() (on page 8-251)
userstring.catalog()
This function creates an iterator for the user-defined string catalog.
Type TSP-Link accessible
Affected by Where saved Default value
Function No
Usage
for name in userstring.catalog() do body end
The name of the string; the key of the key-value pair
Code to execute in the body of the for loop
Details
The catalog provides access for user-defined string pairs, allowing you to manipulate all the key-value pairs in
nonvolatile memory. The entries are enumerated in no particular order.
Example 1
for name in userstring.catalog() do
userstring.delete(name)
Deletes all user-defined strings in nonvolatile
memory.
Example 2
for name in userstring.catalog() do
print(name .. " = " ..
userstring.get(name))
end
Prints all userstring key-value pairs.
Output:
product = Widgets
assetnumber = 236
contact = John Doe
The above output lists the user-defined strings
added in the example for the userstring.add()
function. Notice the key-value pairs are not listed in
the order they were added.
Also see
userstring.add() (on page 8-249)
userstring.delete() (on page 8-251)
userstring.get() (on page 8-251)