2606B System SourceMeter® Instrument Reference Manual
Section 7: TSP command reference
2606B-901-01 Rev. B / May 2018
7-381
Use the
userstring.get()
function to retrieve the
value
associated with the specified
name
.
You can use the
userstring
functions to store custom, instrument-specific information in the
instrument, such as department number, asset number, or manufacturing plant location.
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))
end
Stores user-defined strings in nonvolatile
memory and recalls them from the
instrument using a for loop.
Example output:
assetnumber = 236
contact = John Doe
product = Widgets
Also see
(on page 7-381)
(on page 7-382)
(on page 7-382)
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
name
The name of the string; the key of the key-value pair
body
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)
end
Deletes all user-defined strings in nonvolatile
memory.
Example 2
userstring.add("assetnumber", "236")
userstring.add("product", "Widgets")
userstring.add("contact", "John Doe")
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
Notice the key-value pairs are not listed in
the order they were added.
Also see
(on page 7-382)
(on page 7-382)
