19-234
Return to
2600AS-901-01 Rev. B / September 2008
Section 19: Remote Commands
Series 2600A System SourceMeter® Instruments Reference Manual
userstring
The functions in this group are used to store/retrieve user-defined strings in nonvolatile memory.
userstring.add
Function
Adds a user-defined string to nonvolatile memory.
TSP-Link
accessibility
This function can be accessed from a remote TSP-Link node.
Usage
userstring.add(name, value)
name
The name for the string.
value
The string to associate with the name.
Remarks
This function will associate the string
value
with the string
name
and store the pair in
nonvolatile memory. The value associated with the given name can be retrieved with the
userstring.get
function.
Also see
Example
Stores user-defined strings in nonvolatile memory:
userstring.add("assetnumber", "236")
userstring.add("department", "Widgets")
userstring.add("contact", "John Doe")
userstring.catalog
Function
Creates an iterator for the user string catalog.
TSP-Link
accessibility
This function cannot be accessed from a remote TSP-Link node.
Usage
for name in userstring.catalog() do ... end
name
The variable that assumes the name of each string.
Remarks
• Accessing the catalog for user string names allows the user to print or delete all string name
values in nonvolatile memory. The entries will be enumerated in no particular order.
• Each time the body of the function executes,
name
takes on the value of one string in the
catalog. The
for
loop repeats until all values have been retrieved.
Also see
Example
Deletes all user strings in nonvolatile memory:
for name in userstring.catalog() do
userstring.delete(name)
end
Prints all user string name value pairs in nonvolatile memory:
for name in
userstring.catalog() do
print(name .. " = " .. userstring.get(name))
end
Output:
department = Widgets
assetnumber = 236
contact = John Doe
The above output lists the user strings added in the “Example” for the
function.
Notice that they are not listed in the order that they were added.