GAMS Option API (OPT) Documentation

Generated for GAMS ..

Functions, Procedures, and Properties

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

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
 

Definitions

optCount ↵

Number of options

Type
Property of type Integer
Action
read

optGroupCount ↵

Number of option groups

Type
Property of type Integer
Action
read

optMessageCount ↵

Number of messages in buffer

Type
Property of type Integer
Action
read

optRecentEnabled ↵

When enabled (default), Defined and DefinedR will be set when assigning to an option. When disabled, only Defined will be set

Type
Property of type Integer
Action
read

optRecentEnabledSet ↵

When enabled (default), Defined and DefinedR will be set when assigning to an option. When disabled, only Defined will be set

Type
Property of type Integer
Action
write

optSeparator ↵

Defined separator between option key and value

Type
Property of type ShortString
Action
read

optStringQuote ↵

Defined quote string

Type
Property of type ShortString
Action
read

optAddMessage ↵

Add a message to the message queue

Type
Procedure
Parameters
  const  ShortString    info
     Message string

optClearMessages ↵

Clear all messages stored in the message queue.

Type
Procedure

optDefinitionFile ↵

Get last processed definition file

Type
Procedure
Parameters
  out  ShortString    sfilename
     File name

optDotOptCount ↵

Dot options available and number ignored

Type
Function returns Integer
Parameters
  out  Integer    ANrErrors
     Number of syntactically incorrect dot options

optEchoSet ↵

Set echo of input on or off

Type
Procedure
Parameters
   Integer    AIVal
     Option integer value

optEOLChars ↵

Get eol characters as string returns number of eol chars

Type
Function returns Integer
Parameters
  out  ShortString    EOLChars
     Accepted end of line characters

optEOLOnlySet ↵

Set EOLOnly and return previous value

Type
Function returns Integer
Parameters
   Integer    AIVal
     Option integer value

optErrorCount ↵

Retrieve number of errors / warnings from message queue.

Type
Procedure
Parameters
  out  Integer    iErrors
     Number of errors
  out  Integer    iWarnings
     Number of warnings

optFindStr ↵

Find option by name, return number and ref nr

Type
Function returns Integer
Parameters
  const  ShortString    AName
     Option name
  out  Integer    ANr
     Ordinal option number - an integer between 1..optCount
  out  Integer    ARefNr
     Option reference number

optGetBoundsDbl ↵

Bounds and default for double option

Type
Function returns Integer
Parameters
   Integer    ANr
     Ordinal option number - an integer between 1..optCount
  out  Double    dlval
     Lower bound
  out  Double    dhval
     Upper bound
  out  Double    ddval
     Default value

optGetBoundsInt ↵

Bounds and default for integer option

Type
Function returns Integer
Parameters
   Integer    ANr
     Ordinal option number - an integer between 1..optCount
  out  Integer    ilval
     Lower bound
  out  Integer    ihval
     Upper bound
  out  Integer    idval
     Default value

optGetConstName ↵

Get the name of a constant

Type
Function returns Integer
Parameters
   Integer    cgroup
     Constant group: 1 = Data types, 2 = Option types, 3 = Option sub-type, 4 = Message type
   Integer    cindex
     Constant index
  out  ShortString    cname
     Constant name

optGetDbl2Nr ↵

Read second double by option number

Type
Function returns Integer
Parameters
   Integer    ANr
     Ordinal option number - an integer between 1..optCount
  out  Double    ADVal
     Option double value

optGetDblNr ↵

Read double by option number

Type
Function returns Integer
Parameters
   Integer    ANr
     Ordinal option number - an integer between 1..optCount
  out  Double    ADVal
     Option double value

optGetDblStr ↵

Read double by option name.

Type
Function returns Double
Parameters
  const  ShortString    AName
     Option name

optGetDefaultStr ↵

Default value for a given string option

Type
Function returns Integer
Parameters
   Integer    ANr
     Ordinal option number - an integer between 1..optCount
  out  ShortString    sval
     String list element value

optGetDefinedNr ↵

Get defined status by option number

Type
Function returns Integer
Parameters
   Integer    ANr
     Ordinal option number - an integer between 1..optCount
  out  Integer    AIVal

optGetDefinedStr ↵

Get defined status by option name.

Type
Function returns Boolean
Parameters
  const  ShortString    AName
     Option name

optGetDotOptNr ↵

Dot option info

Type
Function returns Integer
Parameters
   Integer    ANr
     Ordinal option number - an integer between 1..optCount
  out  ShortString    VEName
     Variable or equation name
  out  Integer    AObjNr
  out  Integer    ADim
     Number of indices of variable or equation
  out  Double    AValue
     Option value

optGetDotOptUel ↵

Retrieve a single element from a dot option

Type
Function returns Integer
Parameters
   Integer    ANr
     Ordinal option number - an integer between 1..optCount
   Integer    ADim
     Number of indices of variable or equation
  out  ShortString    AUEL

optGetEnumCount ↵

Number of enumerations in option

Type
Function returns Integer
Parameters
   Integer    ANr
     Ordinal option number - an integer between 1..optCount
  out  Integer    ACount
     Number of enumerations

optGetEnumHelp ↵

Get help text for enumerated value

Type
Function returns Integer
Parameters
   Integer    ANr
     Ordinal option number - an integer between 1..optCount
   Integer    AOrd
     Ordinal position
  out  Integer    AHc
     Help Context number
  out  ShortString    AHelpStr

optGetEnumStrNr ↵

Get enumerated string value and ordinal

Type
Function returns Integer
Parameters
   Integer    ANr
     Ordinal option number - an integer between 1..optCount
  out  ShortString    ASVal
     Option string value
  out  Integer    AOrd
     Ordinal position

optGetEnumValue ↵

Enumerated value by ordinal number

Type
Function returns Integer
Parameters
   Integer    ANr
     Ordinal option number - an integer between 1..optCount
   Integer    AOrd
     Ordinal position
  out  Integer    AValInt
     Option value as integer
  out  ShortString    AValStr
     Option value as string

optGetEquIndicatorNr ↵

Equation part of indicator

Type
Function returns Integer
Parameters
   Integer    ANr
     Ordinal option number - an integer between 1..optCount
   Integer    ADim
     Number of indices of variable or equation
  out  ShortString    AIndex
     Domain index string

optGetEquVarEquMapNr ↵

Equation part of variable equation mapping

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

optGetFromAnyStrList ↵

Read string list element name and value and remove the value. Returns 0 if no string list option found

Type
Function returns Integer
Parameters
   Integer    idash
     Dashed names flag: 0 = do not look for dashed names, 1 = look for dashed names
  out  ShortString    skey
     String list
  out  ShortString    sval
     String list element value

optGetFromListStr ↵

Read and remove queued strings from specified option.

Type
Function returns Integer
Returns
-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
Parameters
  const  ShortString    skey
     String list
  out  ShortString    sval
     String list element value

optGetGroupGrpNr ↵

Get group record by group number

Type
Function returns Integer
Parameters
   Integer    AGroup
     Group number

optGetGroupNr ↵

Get group information by option number

Type
Function returns Integer
Parameters
   Integer    ANr
     Ordinal option number - an integer between 1..optCount
  out  ShortString    AName
     Option name
  out  Integer    AGroup
     Group number
  out  Integer    AHc
     Help Context number
  out  ShortString    AHelp
     Help string

optGetHelpNr ↵

Get option name and help by option number

Type
Function returns Integer
Parameters
   Integer    ANr
     Ordinal option number - an integer between 1..optCount
  out  ShortString    ASOpt
  out  ShortString    ASHelp

optGetIndicatorNr ↵

Indicator info

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

optGetInfoNr ↵

Get information about option by option number

Type
Function returns Integer
Parameters
   Integer    ANr
     Ordinal option number - an integer between 1..optCount
  out  Integer    ADefined
     Flag: 0 if not defined and not 0 if defined
  out  Integer    ADefinedR
     Flag: 0 if not recently defined and not 0 if recently defined
  out  Integer    ARefNr
     Option reference number
  out  Integer    ADataType
     Data type
  out  Integer    AOptType
     Option type
  out  Integer    ASubType
     Option sub type

optGetInt2Nr ↵

Read second integer option by option number

Type
Function returns Integer
Parameters
   Integer    ANr
     Ordinal option number - an integer between 1..optCount
  out  Integer    AIVal
     Option integer value

optGetIntNr ↵

Read integer option by option number

Type
Function returns Integer
Parameters
   Integer    ANr
     Ordinal option number - an integer between 1..optCount
  out  Integer    AIVal
     Option integer value

optGetIntStr ↵

Read integer by option name.

Type
Function returns Integer
Parameters
  const  ShortString    AName
     Option name

optGetMessage ↵

Read from message queue

Type
Procedure
Parameters
   Integer    NrMsg
     Number of messages in message queue
  out  ShortString    info
     Message string
  out  Integer    iType
     Message type value (see enumerated constants)

optGetNameNr ↵

Get option name by option number

Type
Function returns Integer
Parameters
   Integer    ANr
     Ordinal option number - an integer between 1..optCount
  out  ShortString    ASName
     Option name

optGetNameOpt ↵

Extract solver name and optfile number from string option.

Type
Function returns Integer
Parameters
  const  ShortString    ASVal
     Option string value
  out  ShortString    solver
     Solver name
  out  Integer    opt
     Optfile number

optGetOptGroupNr ↵

Get group number of an option by option number

Type
Function returns Integer
Parameters
   Integer    ANr
     Ordinal option number - an integer between 1..optCount

optGetOptHelpNr ↵

Get option name, help context and group number

Type
Function returns Integer
Parameters
   Integer    ANr
     Ordinal option number - an integer between 1..optCount
  out  ShortString    AName
     Option name
  out  Integer    AHc
     Help Context number
  out  Integer    AGroup
     Group number

optGetStr2Nr ↵

Read second string by option number

Type
Function returns Integer
Parameters
   Integer    ANr
     Ordinal option number - an integer between 1..optCount
  out  ShortString    ASVal
     Option string value

optGetStrNr ↵

Read string by option number

Type
Function returns Integer
Parameters
   Integer    ANr
     Ordinal option number - an integer between 1..optCount
  out  ShortString    ASVal
     Option string value

optGetStrStr ↵

Read string by option name.

Type
Function returns ShortString
Parameters
  const  ShortString    AName
     Option name

optGetSynonym ↵

Get synonym and original option name

Type
Function returns Integer
Parameters
   Integer    NrSyn
     Number of the synoym
  out  ShortString    SSyn
     Option synomyn
  out  ShortString    SName
     Option name

optGetTypeName ↵

Get option type name by type number

Type
Function returns Integer
Parameters
   Integer    TNr
     Type number
  out  ShortString    sTName
     Type name

optGetVal2Str ↵

Read second value as string by option name

Type
Function returns Integer
Parameters
  const  ShortString    AName
     Option name
  out  ShortString    ASVal
     Option string value

optGetValStr ↵

Read value as string by option name

Type
Function returns Integer
Parameters
  const  ShortString    AName
     Option name
  out  ShortString    ASVal
     Option string value

optGetValuesNr ↵

Read values

Type
Function returns Integer
Parameters
   Integer    ANr
     Ordinal option number - an integer between 1..optCount
  out  ShortString    ASName
     Option name
  out  Integer    AIVal
     Option integer value
  out  Double    ADVal
     Option double value
  out  ShortString    ASVal
     Option string value

optGetVarEquMapNr ↵

Variable equation mapping info

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

optGetVarIndicatorNr ↵

Variable part of indicator

Type
Function returns Integer
Parameters
   Integer    ANr
     Ordinal option number - an integer between 1..optCount
   Integer    ADim
     Number of indices of variable or equation
  out  ShortString    AIndex
     Domain index string

optGetVarVarEquMapNr ↵

Variable part of variable equation mapping

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

optIndicatorCount ↵

Indicators available and number ignored

Type
Function returns Integer
Parameters
  out  Integer    ANrErrors
     Number of syntactically incorrect dot options

optIsDeprecated ↵

Returns true, if the option is deprecated

Type
Function returns Boolean
Parameters
  const  ShortString    AName
     Option name

optListCountStr ↵

Number of elements stored in list

Type
Function returns Integer
Parameters
  const  ShortString    skey
     String list

optLookUp ↵

Index number of an option

Type
Function returns Integer
Parameters
  const  ShortString    AOpt
     Option name

optNoBoundsSet ↵

Set bound checking on or off

Type
Procedure
Parameters
   Integer    AIVal
     Option integer value

optReadDefinition ↵

Read definition file.

Type
Function returns Integer
Returns
-1 if there was a definition error
Parameters
  const  ShortString    fn
     File name

optReadDefinitionFromPChar ↵

Read definition from array of character

Type
Function returns Integer
Returns
-1 if there was a definition error
Parameters
   PAnsiChar    p
     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).

Type
Procedure
Parameters
  TArgvCB    cb
    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).

Type
Procedure
Parameters
   PAnsiChar    p
     PChar: pointer to first character

optReadFromListStr ↵

Read element iPos from list without removal

Type
Function returns Integer
Parameters
  const  ShortString    skey
     String list
   Integer    iPos
     Position in list
  out  ShortString    sval
     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).

Type
Procedure
Parameters
   PAnsiChar    p
     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)

Type
Procedure
Parameters
  const  ShortString    s
     String

optReadParameterFile ↵

Read parameters from file

Type
Function returns Integer
Parameters
  const  ShortString    fn
     File name

optResetAll ↵

Reset all defined and definedR flags and clear the message queue

Type
Procedure

optResetAllRecent ↵

Reset all definedR flags

Type
Procedure

optResetNr ↵

Reset option value to default

Type
Function returns Integer
Parameters
   Integer    ANr
     Ordinal option number - an integer between 1..optCount

optResetRecentChanges ↵

Reset all options with definedR flag set

Type
Procedure

optResetStr ↵

Reset option to default by option name.

Type
Function returns Boolean
Parameters
  const  ShortString    AName
     Option name

optSetDbl2Nr ↵

Set second double by option number

Type
Function returns Integer
Parameters
   Integer    ANr
     Ordinal option number - an integer between 1..optCount
   Double    ADVal
     Option double value

optSetDblNr ↵

Set double by option number

Type
Function returns Integer
Parameters
   Integer    ANr
     Ordinal option number - an integer between 1..optCount
   Double    ADVal
     Option double value

optSetDblStr ↵

Set double by option name.

Type
Procedure
Parameters
  const  ShortString    AName
     Option name
   Double    ADVal
     Option double value

optSetInt2Nr ↵

Set second integer option by option number

Type
Function returns Integer
Parameters
   Integer    ANr
     Ordinal option number - an integer between 1..optCount
   Integer    AIVal
     Option integer value

optSetIntNr ↵

Set integer option by option number

Type
Function returns Integer
Parameters
   Integer    ANr
     Ordinal option number - an integer between 1..optCount
   Integer    AIVal
     Option integer value

optSetIntStr ↵

Set integer by option name.

Type
Procedure
Parameters
  const  ShortString    AName
     Option name
   Integer    AIVal
     Option integer value

optSetRefNr ↵

Set reference number by option number

Type
Function returns Integer
Parameters
   Integer    ANr
     Ordinal option number - an integer between 1..optCount
   Integer    ARefNr
     Option reference number

optSetRefNrStr ↵

Set reference number by option name

Type
Function returns Integer
Parameters
  const  ShortString    AOpt
     Option name
   Integer    ARefNr
     Option reference number

optSetStr2Nr ↵

Set second string by option number

Type
Function returns Integer
Parameters
   Integer    ANr
     Ordinal option number - an integer between 1..optCount
  const  ShortString    ASVal
     Option string value

optSetStrNr ↵

Set string by option number

Type
Function returns Integer
Parameters
   Integer    ANr
     Ordinal option number - an integer between 1..optCount
  const  ShortString    ASVal
     Option string value

optSetStrStr ↵

Set string by option name.

Type
Procedure
Parameters
  const  ShortString    AName
     Option name
  const  ShortString    ASVal
     Option string value

optSetValues2Nr ↵

Set second values

Type
Function returns Integer
Parameters
   Integer    ANr
     Ordinal option number - an integer between 1..optCount
   Integer    AIVal
     Option integer value
   Double    ADVal
     Option double value
  const  ShortString    ASVal
     Option string value

optSetValuesNr ↵

Set values

Type
Function returns Integer
Parameters
   Integer    ANr
     Ordinal option number - an integer between 1..optCount
   Integer    AIVal
     Option integer value
   Double    ADVal
     Option double value
  const  ShortString    ASVal
     Option string value

optShowHelp ↵

Write help for option(s)

Type
Procedure
Parameters
  const  ShortString    AHlpID
     Help level flags (can be combined): 1 = summary by group, 2 = alphabetical listing, 4 = include large help, 8 = include deprecated and obsolete

optSynonymCount ↵

Number of synonyms

Type
Function returns Integer

optVarEquMapCount ↵

Variable equation mappings available and number ignored

Type
Function returns Integer
Parameters
   Integer    maptype
     Type of variable equation mapping (see enumerated constants)
  out  Integer    ANrErrors
     Number of syntactically incorrect dot options

optVersion ↵

Get version number of object

Type
Procedure
Parameters
  out  ShortString    sversion
     Version number

optWriteParameterFile ↵

Write modified parameters to a file. In the case of errors, messages will be added to the message queue (see OptGetMessage)

Type
Function returns Integer
Parameters
  const  ShortString    fn
     File name