Procedure OptionSetValue(OptionName, NewValue)

OptionSetValue

With the procedure OptionSetValue you can set the value of a numeric AIMMS option. The value assigned to the option must be contained in the option range displayed in the AIMMS Options dialog box.

OptionSetValue(
     OptionName,          ! (input) scalar string expression
     NewValue             ! (input) scalar numeric expression
     )

Arguments

OptionName

A string expression holding the name of the option.

NewValue

A scalar numeric expression representing the new value to be assigned to the option.

Return Value

The procedure returns 1 if the option exists and the value can be assigned to the option, or 0 otherwise.

Note

• Options for which strings are displayed in the AIMMS Options dialog box, are also represented by numerical (integer) values. To obtain the corresponding option keywords, you can use the procedures OptionGetString and OptionGetKeywords.

• The procedure OptionSetValue can also be used to set a solver specific option by prefixing the option name by the name of the solver followed by a double colon ::, e.g., ‘CPLEX 22.1::Integrality’.

• You can also modify option values using the OPTION statement (see also The OPTION and PROPERTY Statements of the Language Reference).

See also

OptionGetString, OptionGetKeywords, OptionSetString.