Provides the keywords for an integer option with keywords.
Parameters |
Description |
_LONG_T int_option_no |
Sequence number of the integer option |
_LONG_T index |
Index of the keyword |
char keyword[] |
Buffer for placing the keyword; the length of the keyword should be at most 36 |
The GetIntegerKeyword method has no return value.
For integer-valued options, AIMMS offers a feature to use descriptive keywords instead of numbers. For example, if your solver has an option for "Create MPS file", then probably in your code this option has an integer value of either 0 or 1.Instead of that the user has to enter a value 0 or 1, you can let him selectbetween the keywords "yes" and "no". If you want to use this feature, you only have to tell AIMMS which keyword belongs to each option value. AIMMS will use these keywords only for display purposes in the Project Options dialog box. The communication of the current values of these option will always be based on the integer numbers.
From the calls to the GetIntegerOption method AIMMS knows whether an integer option uses keywords. If so, the lower and upper bound of the option are used to determine the total number of keywords for that option. Then AIMMS assumes that the keywords are numbered from 0 up to this number of keywords minus 1. For each index in this range the GetIntegerKeyword method should provide a unique keyword.