Zoomed Image

AMSX Scripting Language - Command : SetSpecialOption

Summary

Create or update a special option setting value

Description

Writes a named special option to the database. If the option already exists only the value is updated; arguments 1-4 are only applied when the option is first created. Leave argument 4 blank for a global option or supply a username for a user-specific option.

Parameters

ParameterDescription
cmdoption name (SpecialOptionCode)
Argument 0option value to set
Argument 1UseLookup flag (used only on initial creation)
Argument 2human-readable description of the option (used only on initial creation)
Argument 3class/category of the option (used only on initial creation)
Argument 4leave blank for a global option, or supply a username for a user-specific option

Syntax


SetSpecialOption "option name (SpecialOptionCode)", "option value to set", "UseLookup flag (used only on initial creation)", "human-readable description of the option (used only on initial creation)", "class/category of the option (used only on initial creation)", "leave blank for a global option, or supply a username for a user-specific option"

Return to the AMSX Command Reference