OPT (OPT) API Documentation

Generated for GAMS 34.3.0

Functions, Procedures and Properties

optCount
Number of options.
optMessageCount
Number of messages in buffer.
optGroupCount
Number of option groups.
optRecentEnabled(Set)
When enabled (default), Defined and DefinedR will be set when assigning to an option. When disabled, only Defined will be set
optSeparator
Defined separator between option key and value
optStringQuote
Defined quote string
optReadDefinition
Read definition file. Returns -1 if there was a definition error.
optReadDefinitionFromPChar
Read definition from array of character. Returns -1 if there was a definition error.
optReadParameterFile
Read parameters from file.
optReadFromStr
Read options from string. In the case of errors, messages will be added to the message queue (see OptGetMessage).
optWriteParameterFile
Write modified parameters to a file. In the case of errors, messages will be added to the message queue (see OptGetMessage).
optClearMessages
Clear all messages stored in the message queue.
optAddMessage
Add a message to the message queue.
optGetMessage
Read from message queue.
optResetAll
Reset all defined and definedR flags and clear the message queue.
optResetAllRecent
Reset all definedR flags.
optResetRecentChanges
Reset all options with definedR flag set.
optShowHelp
Write help for option(s)
optResetNr
Reset option value to default.
optFindStr
Find option by name, return number and ref nr.
optGetInfoNr
Get information about option by option number.
optGetValuesNr
Read values.
optSetValuesNr
Set values.
optSetValues2Nr
Set second values.
optVersion
Get version number of object.
optDefinitionFile
Get last processed definition file.
optGetFromAnyStrList
Read string list element name and value and remove the value. Returns 0 if no string list option found
optGetFromListStr
Read and remove queued strings from specified option. Return values are: -2 if option not found, -1 if option is not a string list, 0 if string list is empty, 1 if item returned and remove.
optListCountStr
Number of elements stored in list.
optReadFromListStr
Read element iPos from list without removal.
optSynonymCount
Number of synonyms.
optGetSynonym
Get synonym and original option name.
optEchoSet
Set echo of input on or off.
optEOLOnlySet
Set EOLOnly and return previous value.
optNoBoundsSet
Set bound checking on or off.
optEOLChars
Get eol characters as string returns number of eol chars.
optErrorCount
Retrieve number of errors / warnings from message queue.
optGetBoundsInt
Bounds and default for integer option.
optGetBoundsDbl
Bounds and default for double option.
optGetDefaultStr
Default value for a given string option.
optGetIntNr
Read integer option by option number.
optGetInt2Nr
Read second integer option by option number.
optSetIntNr
Set integer option by option number.
optSetInt2Nr
Set second integer option by option number.
optGetStrNr
Read string by option number.
optGetOptHelpNr
Get option name, help context and group number.
optGetEnumHelp
Get help text for enumerated value.
optGetEnumStrNr
Get enumerated string value and ordinal.
optGetEnumCount
Number of enumerations in option.
optGetEnumValue
Enumerated value by ordinal number.
optGetStr2Nr
Read second string by option number.
optSetStrNr
Set string by option number.
optSetStr2Nr
Set second string by option number.
optGetDblNr
Read double by option number.
optGetDbl2Nr
Read second double by option number.
optSetDblNr
Set double by option number.
optSetDbl2Nr
Set second double by option number.
optGetValStr
Read value as string by option name.
optGetVal2Str
Read second value as string by option name.
optGetNameNr
Get option name by option number.
optGetDefinedNr
Get defined status by option number.
optGetHelpNr
Get option name and help by option number.
optGetGroupNr
Get group information by option number.
optGetGroupGrpNr
Get group record by group number.
optGetOptGroupNr
Get group number of an option by option number.
optGetDotOptNr
Dot option info.
optGetDotOptUel
Retrieve a single element from a dot option.
optGetVarEquMapNr
Variable equation mapping info.
optGetEquVarEquMapNr
Equation part of variable equation mapping.
optGetVarVarEquMapNr
Variable part of variable equation mapping.
optVarEquMapCount
Variable equation mappings available and number ignored.
optGetIndicatorNr
Indicator info.
optGetEquIndicatorNr
Equation part of indicator.
optGetVarIndicatorNr
Variable part of indicator.
optIndicatorCount
Indicators available and number ignored.
optDotOptCount
Dot options available and number ignored.
optSetRefNr
Set reference number by option number.
optSetRefNrStr
Set reference number by option name.
optGetConstName
Get the name of a constant.
optGetTypeName
Get option type name by type number.
optLookUp
Index number of an option.
optReadFromPChar
Read options from a PChar. In the case of errors, messages will be added to the message queue (see OptGetMessage).
optReadFromCmdLine
Read options from a PChar. In the case of errors, messages will be added to the message queue indicated as command line (see OptGetMessage).
optReadFromCmdArgs
Read options from shortStrings returned by callback func cb. In the case of errors, messages will be added to the message queue indicated as command line args (see OptGetMessage).
optGetNameOpt
Extract solver name and optfile number from string option.
optResetStr
Reset option to default by option name.
optGetDefinedStr
Get defined status by option name.
optGetIntStr
Read integer by option name.
optGetDblStr
Read double by option name.
optGetStrStr
Read string by option name.
optSetIntStr
Set integer by option name.
optSetDblStr
Set double by option name.
optSetStrStr
Set string by option name.
optIsDeprecated
Returns true, if the option is deprecated

Arguments

ACount
Number of enumerations
ADataType
Data type
ADefined
Flag: 0 if not defined and <>0 if defined
ADefinedR
Flag: 0 if not recently defined and <>0 if recently defined
ADim
Number of indices of variable or equation
ADVal
Option double value
AGroup
Group number
AHc
Help Context number
AHelp
One line help text
AHelpStr
Help string
AHlpID
Help level flags (can be combined): 1 = summary by group, 2 = alphabetical listing, 4 = include large help, 8 = include deprecated and obsolete
AIndex
Domain index string
AIVal
Option integer value
AName
Option name
ANr
Ordinal option number - an integer between 1..optCount
ANrErrors
Number of syntactically incorrect dot options
AObjNr
Numeric index of suffix in dot option
AOpt
Option name
AOptType
Option type
AOrd
Ordinal position
ARefNr
Option reference number
ASHelp
Help string
ASName
Option name
ASOpt
Option name
ASubType
Option sub type
ASVal
Option string value
AUEL
Single element from a dot option
AValInt
Option value as integer
AValStr
Option value as string
AValue
Option value
cgroup
Constant group: 1 = Data types, 2 = Option types, 3 = Option sub-type, 4 = Message type
cindex
Constant index
cname
Constant name
ddval
Default value
dhval
Upper bound
dlval
Lower bound
EOLChars
Accepted end of line characters
EquDim
Equation dimension in indicator option
EquName
Equation name in indicator option
fn
File name
idash
Dashed names flag: 0 = do not look for dashed names, 1 = look for dashed names
idval
Default value
iErrors
Number of errors
ihval
Upper bound
ilval
Lower bound
info
Message string
iPos
Position in list
iType
Message type value (see enumerated constants)
iWarnings
Number of warnings
maptype
Type of variable equation mapping (see enumerated constants)
NrMsg
Number of messages in message queue
NrSyn
Number of the synoym
opt
Optfile number
p
PChar: pointer to first character
result
Result/Return code of function
s
String
sfilename
File name
skey
String list
SName
Option name
solver
Solver name
SSyn
Option synomyn
sTName
Type name
sval
String list element value
sversion
Version number
TNr
Type number
VarDim
Variable dimension in indicator option
VarName
Variable name in indicator option
VEName
Variable or equation name

Calling Sequences

optAddMessage

  • Add a message to the message queue.
  • Procedure
  • Arguments:
      • const info : ShortString
      Message string

optClearMessages

  • Clear all messages stored in the message queue.
  • Procedure

optCount

  • Number of options.
  • Property of type Integer
  • Actions
    • r

optDefinitionFile

  • Get last processed definition file.
  • Procedure
  • Arguments:
      • out sfilename: ShortString
      File name

optDotOptCount

  • Dot options available and number ignored.
  • Function returns Integer
  • Arguments:
      • out ANrErrors: Integer
      Number of syntactically incorrect dot options

optEchoSet

  • Set echo of input on or off.
  • Procedure
  • Arguments:
      • AIVal : Integer
      Option integer value

optEOLChars

  • Get eol characters as string returns number of eol chars.
  • Function returns Integer
  • Arguments:
      • out EOLChars : ShortString
      Accepted end of line characters

optEOLOnlySet

  • Set EOLOnly and return previous value.
  • Function returns Integer
  • Arguments:
      • AIVal : Integer
      Option integer value

optErrorCount

  • Retrieve number of errors / warnings from message queue.
  • Procedure
  • Arguments:
      • out iErrors : Integer
      Number of errors
      out iWarnings: Integer
      Number of warnings

optFindStr

  • Find option by name, return number and ref nr.
  • Function returns Integer
  • Arguments:
      • const AName : ShortString
      Option name
      out ANr : Integer
      Ordinal option number - an integer between 1..optCount
      out ARefNr : Integer
      Option reference number

optGetBoundsDbl

  • Bounds and default for double option.
  • Function returns Integer
  • Arguments:
      • ANr : Integer
      Ordinal option number - an integer between 1..optCount
      out dlval : Double
      Lower bound
      out dhval : Double
      Upper bound
      out ddval : Double
      Default value

optGetBoundsInt

  • Bounds and default for integer option.
  • Function returns Integer
  • Arguments:
      • ANr : Integer
      Ordinal option number - an integer between 1..optCount
      out ilval : Integer
      Lower bound
      out ihval : Integer
      Upper bound
      out idval : Integer
      Default value

optGetConstName

  • Get the name of a constant.
  • Function returns Integer
  • Arguments:
      • cgroup : Integer
      Constant group: 1 = Data types, 2 = Option types, 3 = Option sub-type, 4 = Message type
      cindex : Integer
      Constant index
      out cname : ShortString
      Constant name

optGetDbl2Nr

  • Read second double by option number.
  • Function returns Integer
  • Arguments:
      • ANr : Integer
      Ordinal option number - an integer between 1..optCount
      out ADVal : Double
      Option double value

optGetDblNr

  • Read double by option number.
  • Function returns Integer
  • Arguments:
      • ANr : Integer
      Ordinal option number - an integer between 1..optCount
      out ADVal : Double
      Option double value

optGetDblStr

  • Read double by option name.
  • Function returns Double
  • Arguments:
      • const AName : ShortString
      Option name

optGetDefaultStr

  • Default value for a given string option.
  • Function returns Integer
  • Arguments:
      • ANr : Integer
      Ordinal option number - an integer between 1..optCount
      out sval : ShortString
      String list element value

optGetDefinedNr

  • Get defined status by option number.
  • Function returns Integer
  • Arguments:
      • ANr : Integer
      Ordinal option number - an integer between 1..optCount
      out AIVal : Integer
      Option integer value

optGetDefinedStr

  • Get defined status by option name.
  • Function returns Boolean
  • Arguments:
      • const AName : ShortString
      Option name

optGetDotOptNr

  • Dot option info.
  • Function returns Integer
  • Arguments:
      • ANr : Integer
      Ordinal option number - an integer between 1..optCount
      out VEName : ShortString
      Variable or equation name
      out AObjNr : Integer
      Numeric index of suffix in dot option
      out ADim : Integer
      Number of indices of variable or equation
      out AValue : Double
      Option value

optGetDotOptUel

  • Retrieve a single element from a dot option.
  • Function returns Integer
  • Arguments:
      • ANr : Integer
      Ordinal option number - an integer between 1..optCount
      ADim : Integer
      Number of indices of variable or equation
      out AUEL : ShortString
      Single element from a dot option

optGetEnumCount

  • Number of enumerations in option.
  • Function returns Integer
  • Arguments:
      • ANr : Integer
      Ordinal option number - an integer between 1..optCount
      out ACount : Integer
      Number of enumerations

optGetEnumHelp

  • Get help text for enumerated value.
  • Function returns Integer
  • Arguments:
      • ANr : Integer
      Ordinal option number - an integer between 1..optCount
      AOrd : Integer
      Ordinal position
      out AHc : Integer
      Help Context number
      out AHelpStr : ShortString
      Help string

optGetEnumStrNr

  • Get enumerated string value and ordinal.
  • Function returns Integer
  • Arguments:
      • ANr : Integer
      Ordinal option number - an integer between 1..optCount
      out ASVal : ShortString
      Option string value
      out AOrd : Integer
      Ordinal position

optGetEnumValue

  • Enumerated value by ordinal number.
  • Function returns Integer
  • Arguments:
      • ANr : Integer
      Ordinal option number - an integer between 1..optCount
      AOrd : Integer
      Ordinal position
      out AValInt : Integer
      Option value as integer
      out AValStr : ShortString
      Option value as string

optGetEquIndicatorNr

  • Equation part of indicator.
  • Function returns Integer
  • Arguments:
      • ANr : Integer
      Ordinal option number - an integer between 1..optCount
      ADim : Integer
      Number of indices of variable or equation
      out AIndex : ShortString
      Domain index string

optGetEquVarEquMapNr

  • Equation part of variable equation mapping.
  • Function returns Integer
  • Arguments:
      • maptype : Integer
      Type of variable equation mapping (see enumerated constants)
      ANr : Integer
      Ordinal option number - an integer between 1..optCount
      ADim : Integer
      Number of indices of variable or equation
      out AIndex : ShortString
      Domain index string

optGetFromAnyStrList

  • Read string list element name and value and remove the value. Returns 0 if no string list option found
  • Function returns Integer
  • Arguments:
      • idash : Integer
      Dashed names flag: 0 = do not look for dashed names, 1 = look for dashed names
      out skey : ShortString
      String list
      out sval : ShortString
      String list element value

optGetFromListStr

  • Read and remove queued strings from specified option. Return values are: -2 if option not found, -1 if option is not a string list, 0 if string list is empty, 1 if item returned and remove.
  • Function returns Integer
  • Arguments:
      • const skey : ShortString
      String list
      out sval : ShortString
      String list element value

optGetGroupGrpNr

  • Get group record by group number.
  • Function returns Integer
  • Arguments:
      • AGroup : Integer
      Group number

optGetGroupNr

  • Get group information by option number.
  • Function returns Integer
  • Arguments:
      • ANr : Integer
      Ordinal option number - an integer between 1..optCount
      out AName : ShortString
      Option name
      out AGroup : Integer
      Group number
      out AHc : Integer
      Help Context number
      out AHelp : ShortString
      One line help text

optGetHelpNr

  • Get option name and help by option number.
  • Function returns Integer
  • Arguments:
      • ANr : Integer
      Ordinal option number - an integer between 1..optCount
      out ASOpt : ShortString
      Option name
      out ASHelp : ShortString
      Help string

optGetIndicatorNr

  • Indicator info.
  • Function returns Integer
  • Arguments:
      • ANr : Integer
      Ordinal option number - an integer between 1..optCount
      out EquName : ShortString
      Equation name in indicator option
      out VarName : ShortString
      Variable name in indicator option
      out EquDim : Integer
      Equation dimension in indicator option
      out VarDim : Integer
      Variable dimension in indicator option
      out AValue : Integer
      Option value

optGetInfoNr

  • Get information about option by option number.
  • Function returns Integer
  • Arguments:
      • ANr : Integer
      Ordinal option number - an integer between 1..optCount
      out ADefined : Integer
      Flag: 0 if not defined and <>0 if defined
      out ADefinedR: Integer
      Flag: 0 if not recently defined and <>0 if recently defined
      out ARefNr : Integer
      Option reference number
      out ADataType: Integer
      Data type
      out AOptType : Integer
      Option type
      out ASubType : Integer
      Option sub type

optGetInt2Nr

  • Read second integer option by option number.
  • Function returns Integer
  • Arguments:
      • ANr : Integer
      Ordinal option number - an integer between 1..optCount
      out AIVal : Integer
      Option integer value

optGetIntNr

  • Read integer option by option number.
  • Function returns Integer
  • Arguments:
      • ANr : Integer
      Ordinal option number - an integer between 1..optCount
      out AIVal : Integer
      Option integer value

optGetIntStr

  • Read integer by option name.
  • Function returns Integer
  • Arguments:
      • const AName : ShortString
      Option name

optGetMessage

  • Read from message queue.
  • Procedure
  • Arguments:
      • NrMsg : Integer
      Number of messages in message queue
      out info : ShortString
      Message string
      out iType : Integer
      Message type value (see enumerated constants)

optGetNameNr

  • Get option name by option number.
  • Function returns Integer
  • Arguments:
      • ANr : Integer
      Ordinal option number - an integer between 1..optCount
      out ASName : ShortString
      Option name

optGetNameOpt

  • Extract solver name and optfile number from string option.
  • Function returns Integer
  • Arguments:
      • const ASVal : ShortString
      Option string value
      out solver : ShortString
      Solver name
      out opt : Integer
      Optfile number

optGetOptGroupNr

  • Get group number of an option by option number.
  • Function returns Integer
  • Arguments:
      • ANr : Integer
      Ordinal option number - an integer between 1..optCount

optGetOptHelpNr

  • Get option name, help context and group number.
  • Function returns Integer
  • Arguments:
      • ANr : Integer
      Ordinal option number - an integer between 1..optCount
      out AName : ShortString
      Option name
      out AHc : Integer
      Help Context number
      out AGroup : Integer
      Group number

optGetStr2Nr

  • Read second string by option number.
  • Function returns Integer
  • Arguments:
      • ANr : Integer
      Ordinal option number - an integer between 1..optCount
      out ASVal : ShortString
      Option string value

optGetStrNr

  • Read string by option number.
  • Function returns Integer
  • Arguments:
      • ANr : Integer
      Ordinal option number - an integer between 1..optCount
      out ASVal : ShortString
      Option string value

optGetStrStr

  • Read string by option name.
  • Function returns ShortString
  • Arguments:
      • const AName : ShortString
      Option name

optGetSynonym

  • Get synonym and original option name.
  • Function returns Integer
  • Arguments:
      • NrSyn : Integer
      Number of the synoym
      out SSyn : ShortString
      Option synomyn
      out SName : ShortString
      Option name

optGetTypeName

  • Get option type name by type number.
  • Function returns Integer
  • Arguments:
      • TNr : Integer
      Type number
      out sTName : ShortString
      Type name

optGetVal2Str

  • Read second value as string by option name.
  • Function returns Integer
  • Arguments:
      • const AName : ShortString
      Option name
      out ASVal : ShortString
      Option string value

optGetValStr

  • Read value as string by option name.
  • Function returns Integer
  • Arguments:
      • const AName : ShortString
      Option name
      out ASVal : ShortString
      Option string value

optGetValuesNr

  • Read values.
  • Function returns Integer
  • Arguments:
      • ANr : Integer
      Ordinal option number - an integer between 1..optCount
      out ASName : ShortString
      Option name
      out AIVal : Integer
      Option integer value
      out ADVal : Double
      Option double value
      out ASVal : ShortString
      Option string value

optGetVarEquMapNr

  • Variable equation mapping info.
  • Function returns Integer
  • Arguments:
      • maptype : Integer
      Type of variable equation mapping (see enumerated constants)
      ANr : Integer
      Ordinal option number - an integer between 1..optCount
      out EquName : ShortString
      Equation name in indicator option
      out VarName : ShortString
      Variable name in indicator option
      out EquDim : Integer
      Equation dimension in indicator option
      out VarDim : Integer
      Variable dimension in indicator option
      out AValue : Integer
      Option value

optGetVarIndicatorNr

  • Variable part of indicator.
  • Function returns Integer
  • Arguments:
      • ANr : Integer
      Ordinal option number - an integer between 1..optCount
      ADim : Integer
      Number of indices of variable or equation
      out AIndex : ShortString
      Domain index string

optGetVarVarEquMapNr

  • Variable part of variable equation mapping.
  • Function returns Integer
  • Arguments:
      • maptype : Integer
      Type of variable equation mapping (see enumerated constants)
      ANr : Integer
      Ordinal option number - an integer between 1..optCount
      ADim : Integer
      Number of indices of variable or equation
      out AIndex : ShortString
      Domain index string

optGroupCount

  • Number of option groups.
  • Property of type Integer
  • Actions
    • r

optIndicatorCount

  • Indicators available and number ignored.
  • Function returns Integer
  • Arguments:
      • out ANrErrors: Integer
      Number of syntactically incorrect dot options

optIsDeprecated

  • Returns true, if the option is deprecated
  • Function returns Boolean
  • Arguments:
      • const AName : ShortString
      Option name

optListCountStr

  • Number of elements stored in list.
  • Function returns Integer
  • Arguments:
      • const skey : ShortString
      String list

optLookUp

  • Index number of an option.
  • Function returns Integer
  • Arguments:
      • const AOpt : ShortString
      Option name

optMessageCount

  • Number of messages in buffer.
  • Property of type Integer
  • Actions
    • r

optNoBoundsSet

  • Set bound checking on or off.
  • Procedure
  • Arguments:
      • AIVal : Integer
      Option integer value

optReadDefinition

  • Read definition file. Returns -1 if there was a definition error.
  • Function returns Integer
  • Arguments:
      • const fn : ShortString
      File name

optReadDefinitionFromPChar

  • Read definition from array of character. Returns -1 if there was a definition error.
  • Function returns Integer
  • Arguments:
      • p : PAnsiChar
      PChar: pointer to first character

optReadFromCmdArgs

  • Read options from shortStrings returned by callback func cb. In the case of errors, messages will be added to the message queue indicated as command line args (see OptGetMessage).
  • Procedure
  • Arguments:
      • cb : TArgvCB
      Function(out argv:ShortString, var idx:Integer) returns Boolean

optReadFromCmdLine

  • Read options from a PChar. In the case of errors, messages will be added to the message queue indicated as command line (see OptGetMessage).
  • Procedure
  • Arguments:
      • p : PAnsiChar
      PChar: pointer to first character

optReadFromListStr

  • Read element iPos from list without removal.
  • Function returns Integer
  • Arguments:
      • const skey : ShortString
      String list
      iPos : Integer
      Position in list
      out sval : ShortString
      String list element value

optReadFromPChar

  • Read options from a PChar. In the case of errors, messages will be added to the message queue (see OptGetMessage).
  • Procedure
  • Arguments:
      • p : PAnsiChar
      PChar: pointer to first character

optReadFromStr

  • Read options from string. In the case of errors, messages will be added to the message queue (see OptGetMessage).
  • Procedure
  • Arguments:
      • const s : ShortString
      String

optReadParameterFile

  • Read parameters from file.
  • Function returns Integer
  • Arguments:
      • const fn : ShortString
      File name

optRecentEnabled(Set)

  • When enabled (default), Defined and DefinedR will be set when assigning to an option. When disabled, only Defined will be set
  • Property of type Integer
  • Actions
    • r
    • w

optResetAll

  • Reset all defined and definedR flags and clear the message queue.
  • Procedure

optResetAllRecent

  • Reset all definedR flags.
  • Procedure

optResetNr

  • Reset option value to default.
  • Function returns Integer
  • Arguments:
      • ANr : Integer
      Ordinal option number - an integer between 1..optCount

optResetRecentChanges

  • Reset all options with definedR flag set.
  • Procedure

optResetStr

  • Reset option to default by option name.
  • Function returns Boolean
  • Arguments:
      • const AName : ShortString
      Option name

optSeparator

  • Defined separator between option key and value
  • Property of type ShortString
  • Actions
    • r

optSetDbl2Nr

  • Set second double by option number.
  • Function returns Integer
  • Arguments:
      • ANr : Integer
      Ordinal option number - an integer between 1..optCount
      ADVal : Double
      Option double value

optSetDblNr

  • Set double by option number.
  • Function returns Integer
  • Arguments:
      • ANr : Integer
      Ordinal option number - an integer between 1..optCount
      ADVal : Double
      Option double value

optSetDblStr

  • Set double by option name.
  • Procedure
  • Arguments:
      • const AName : ShortString
      Option name
      ADVal : Double
      Option double value

optSetInt2Nr

  • Set second integer option by option number.
  • Function returns Integer
  • Arguments:
      • ANr : Integer
      Ordinal option number - an integer between 1..optCount
      AIVal : Integer
      Option integer value

optSetIntNr

  • Set integer option by option number.
  • Function returns Integer
  • Arguments:
      • ANr : Integer
      Ordinal option number - an integer between 1..optCount
      AIVal : Integer
      Option integer value

optSetIntStr

  • Set integer by option name.
  • Procedure
  • Arguments:
      • const AName : ShortString
      Option name
      AIVal : Integer
      Option integer value

optSetRefNr

  • Set reference number by option number.
  • Function returns Integer
  • Arguments:
      • ANr : Integer
      Ordinal option number - an integer between 1..optCount
      ARefNr : Integer
      Option reference number

optSetRefNrStr

  • Set reference number by option name.
  • Function returns Integer
  • Arguments:
      • const AOpt : ShortString
      Option name
      ARefNr : Integer
      Option reference number

optSetStr2Nr

  • Set second string by option number.
  • Function returns Integer
  • Arguments:
      • ANr : Integer
      Ordinal option number - an integer between 1..optCount
      const ASVal : ShortString
      Option string value

optSetStrNr

  • Set string by option number.
  • Function returns Integer
  • Arguments:
      • ANr : Integer
      Ordinal option number - an integer between 1..optCount
      const ASVal : ShortString
      Option string value

optSetStrStr

  • Set string by option name.
  • Procedure
  • Arguments:
      • const AName : ShortString
      Option name
      const ASVal : ShortString
      Option string value

optSetValues2Nr

  • Set second values.
  • Function returns Integer
  • Arguments:
      • ANr : Integer
      Ordinal option number - an integer between 1..optCount
      AIVal : Integer
      Option integer value
      ADVal : Double
      Option double value
      const ASVal : ShortString
      Option string value

optSetValuesNr

  • Set values.
  • Function returns Integer
  • Arguments:
      • ANr : Integer
      Ordinal option number - an integer between 1..optCount
      AIVal : Integer
      Option integer value
      ADVal : Double
      Option double value
      const ASVal : ShortString
      Option string value

optShowHelp

  • Write help for option(s)
  • Procedure
  • Arguments:
      • const AHlpID : ShortString
      Help level flags (can be combined): 1 = summary by group, 2 = alphabetical listing, 4 = include large help, 8 = include deprecated and obsolete

optStringQuote

  • Defined quote string
  • Property of type ShortString
  • Actions
    • r

optSynonymCount

  • Number of synonyms.
  • Function returns Integer

optVarEquMapCount

  • Variable equation mappings available and number ignored.
  • Function returns Integer
  • Arguments:
      • maptype : Integer
      Type of variable equation mapping (see enumerated constants)
      out ANrErrors: Integer
      Number of syntactically incorrect dot options

optVersion

  • Get version number of object.
  • Procedure
  • Arguments:
      • out sversion : ShortString
      Version number

optWriteParameterFile

  • Write modified parameters to a file. In the case of errors, messages will be added to the message queue (see OptGetMessage).
  • Function returns Integer
  • Arguments:
      • const fn : ShortString
      File name

Enumerated Constants

  • optDataType
    • optDataNone = 0
    • optDataInteger = 1
    • optDataDouble = 2
    • optDataString = 3
    • optDataStrList = 4
  • optOptionType
    • optTypeInteger = 0
    • optTypeDouble = 1
    • optTypeString = 2
    • optTypeBoolean = 3
    • optTypeEnumStr = 4
    • optTypeEnumInt = 5
    • optTypeMultiList = 6
    • optTypeStrList = 7
    • optTypeMacro = 8
    • optTypeImmediate = 9
  • optOptionSubType
    • optsubRequired = 0
    • optsubNoValue = 1
    • optsubOptional = 2
    • optsub2Values = 3
  • optMsgType
    • optMsgInputEcho = 0
    • optMsgHelp = 1
    • optMsgDefineError = 2
    • optMsgValueError = 3
    • optMsgValueWarning = 4
    • optMsgDeprecated = 5
    • optMsgFileEnter = 6
    • optMsgFileLeave = 7
    • optMsgTooManyMsgs = 8
    • optMsgUserError = 9
  • optVarEquMapType
    • optMapIndicator = 0
    • optMapDefinedVar = 1

Undocumented Arguments

  • cb