- Procedure OptionGetString(OptionName, CurrentString)
OptionGetString
With the procedure OptionGetString
you can obtain the string
representation of the current value of an AIMMS option, as displayed in
the AIMMS Options dialog box.
OptionGetString(
OptionName, ! (input) scalar string expression
CurrentString ! (output) scalar string parameter
)
Arguments
- OptionName
A string expression holding the name of the option.
- CurrentString
A scalar string parameter that, on return, contains the string representation of the current value of the option.
Return Value
The procedure returns 1 if the option exists, or 0 if the name refers to a non-existent option.
Note
Options for which strings are displayed in the AIMMS Options dialog
box, are represented by numerical (integer) values internally. To obtain
the numerical option value, or to obtain the mapping between numerical
option values and the corresponding string keywords, you can use the
procedures OptionGetValue
and OptionGetKeywords
.
See also