UserVars()
The UserVars function returns a handle to the set of user variables. Read more about these in the Variables topic in the Macro section.
Arguments
Section titled “Arguments”This function does not accept any arguments.
Return
Section titled “Return”- Handle:
The function returns a handle of the set of user variables.
Example
Section titled “Example”This example sets, gets, and deletes a user variable:
| Copy CodeLua |
| ``` |
| return function() |
-- Stores a local Lua variable with the handle for the user variables.local variableSection = UserVars()
-- Sets a user variable with an integer value using the SetVar function.SetVar(variableSection, "myUserVar", 42)
-- Prints the user variable using the GetVar function.Printf("The value of myUserVar is: " .. GetVar(variableSection, "myUserVar"))
-- Deletes the user variable using the DelVar function.DelVar(variableSection, "myUserVar")end