Equinox Online Help - Language Reference - A to Z

Home

UserOptionName

Applies to
SyntaxUserOptionName ([OptionNumber])
Action[Function] Returns the string associated with a form user option, or ""
ScopeUsable anywhere, but only returns a value in forms.
Notes

The optional parameter OptionNumber should be a value in the range 1 to 256. To discover the name of the currently running option, omit the parameter or supply a value of zero. If an error occurs, the system workarea SysError is set to a nonzero value.

Category  
See Also  
Example

This example retrieves the name of the currently running user option, if any.

string sName
sName = UserOptionName()

This example iterates through the possible options, printing those which have a name.

number i
string s

for i = 1 to 256
s = UserOptionName(i)
if s <> "" then print "Option", Str(i, 3,, 16), "'"; s; "'"
next