Procedure GMP::SolverSession::SetOptionValue(solverSession, OptionName, Value)

GMP::SolverSession::SetOptionValue

The procedure GMP::SolverSession::SetOptionValue sets the value of a solver specific option for a solver session. To a solver session corresponds to one unique solver, and the option will only be set for that solver.

GMP::SolverSession::SetOptionValue(
     solverSession,    ! (input) a solver session
     OptionName,       ! (input) a scalar string expression
     Value             ! (input) a scalar numeric expression
     )

Arguments

solverSession

An element in the set AllSolverSessions.

OptionName

A string expression holding the name of the option.

Value

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

• The option value of a solver specific option can also be set in other ways. The value of an option belonging to a solver session is determined by:

  • the procedure GMP::SolverSession::SetOptionValue if it is called for the solver session, else

  • the procedure GMP::Instance::SetOptionValue if it is called for the generated mathematical program corresponding to the solver session, else

  • the value used in the OPTION statement if that statement is used (see also The OPTION and PROPERTY Statements of the Language Reference), else

  • the option value in the option tree.

• 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 functions OptionGetString and OptionGetKeywords.

See also

• The routines GMP::Instance::GetOptionValue, GMP::Instance::SetOptionValue, GMP::SolverSession::GetOptionValue, OptionGetString and OptionGetKeywords.