Function GMP::SolverSession::GetOptionValue(solverSession, OptionName)

GMP::SolverSession::GetOptionValue

The function GMP::SolverSession::GetOptionValue returns the value of a solver specific option for a solver session.

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

Arguments

solverSession

An element in the set AllSolverSessions.

OptionName

A string expression holding the name of the option.

Return Value

In case of success, the function returns the current option value. Otherwise it returns UNDF.

Note

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::SetOptionValue, OptionGetString and OptionGetKeywords.