FUNCTION REFERENCE

  • Elementary Computational Operations
    • Arithmetic Functions
      • Abs
      • ArcCos
      • ArcCosh
      • ArcSin
      • ArcSinh
      • ArcTan
      • ArcTanh
      • Ceil
      • Cos
      • Cosh
      • Cube
      • Degrees
      • Div
      • ErrorF
      • Exp
      • Floor
      • Log
      • Log10
      • MapVal
      • Max
      • Min
      • Mod
      • Power
      • Precision
      • Radians
      • Round
      • ScalarValue
      • Sign
      • Sin
      • Sinh
      • Sqr
      • Sqrt
      • Tan
      • Tanh
      • Trunc
      • Val
    • Set Related Functions
      • ActiveCard
      • Card
      • CloneElement
      • Element
      • ElementCast
      • ElementRange
      • FindUsedElements
      • First
      • Last
      • Ord
      • RestoreInactiveElements
      • SetAddRecursive
      • SetAsString
      • SetElementAdd
      • SetElementRename
      • StringToElement
      • SubRange
    • String Manipulation Functions
      • Character
      • CharacterNumber
      • FindNthString
      • FindReplaceNthString
      • FindReplaceStrings
      • FindString
      • FormatString
      • GarbageCollectStrings
      • RegexSearch
      • RegexReplace
      • StringCapitalize
      • StringLength
      • StringOccurrences
      • StringToLower
      • StringToUpper
      • SubString
    • Unit Functions
      • AtomicUnit
      • ConvertUnit
      • EvaluateUnit
      • StringToUnit
      • Unit
    • Time Functions
      • Aggregate
      • ConvertReferenceDate
      • CreateTimeTable
      • CurrentToMoment
      • CurrentToString
      • CurrentToTimeSlot
      • DaylightSavingEndDate
      • DaylightSavingStartDate
      • DisAggregate
      • MomentToString
      • MomentToTimeSlot
      • PeriodToString
      • StringToMoment
      • StringToTimeSlot
      • TestDate
      • TimeSlotCharacteristic
      • TimeSlotToMoment
      • TimeSlotToString
      • TimeZoneOffSet
    • Financial Functions
      • General Conversions
        • PriceDecimal
        • PriceFractional
        • RateEffective
        • RateNominal
      • Day Count Bases and Dates
        • DateDifferenceDays
        • DateDifferenceYearFraction
      • Depreciations
        • DepreciationLinearLife
        • DepreciationLinearRate
        • DepreciationNonLinearSumOfYear
        • DepreciationNonLinearFactor
        • DepreciationNonLinearLife
        • DepreciationNonLinearRate
        • DepreciationSum
      • Investments
        • InvestmentConstantFutureValue
        • InvestmentConstantPeriodicPayment
        • InvestmentConstantPresentValue
        • InvestmentConstantInterestPayment
        • InvestmentConstantPrincipalPayment
        • InvestmentConstantCumulativeInterestPayment
        • InvestmentConstantCumulativePrincipalPayment
        • InvestmentConstantNumberPeriods
        • InvestmentConstantRate
        • InvestmentConstantRateAll
        • InvestmentVariablePresentValue
        • InvestmentVariablePresentValueInPeriodic
        • InvestmentSingleFutureValue
        • InvestmentVariableInternalRateReturn
        • InvestmentVariableInternalRateReturnAll
        • InvestmentVariableInternalRateReturnInPeriodic
        • InvestmentVariableInternalRateReturnInPeriodicAll
        • InvestmentVariableInternalRateReturnModified
      • Securities
        • SecurityDiscountedPrice
        • SecurityDiscountedRedemption
        • SecurityDiscountedYield
        • SecurityDiscountedRate
        • TreasuryBillPrice
        • TreasuryBillYield
        • TreasuryBillBondEquivalent
        • SecurityMaturityPrice
        • SecurityMaturityCouponRate
        • SecurityMaturityYield
        • SecurityMaturityAccruedInterest
        • SecurityCouponNumber
        • SecurityCouponPreviousDate
        • SecurityCouponNextDate
        • SecurityCouponDays
        • SecurityCouponDaysPreSettlement
        • SecurityCouponDaysPostSettlement
        • SecurityPeriodicPrice
        • SecurityPeriodicRedemption
        • SecurityPeriodicCouponRate
        • SecurityPeriodicYieldAll
        • SecurityPeriodicYield
        • SecurityPeriodicAccruedInterest
        • SecurityPeriodicDuration
        • SecurityPeriodicDurationModified
    • Distribution and Combinatoric Functions
      • Binomial
      • Geometric
      • HyperGeometric
      • NegativeBinomial
      • Poisson
      • Beta
      • Exponential
      • ExtremeValue
      • Gamma
      • Logistic
      • LogNormal
      • Normal
      • Pareto
      • Triangular
      • Uniform
      • Weibull
      • DistributionCumulative
      • DistributionDensity
      • DistributionDeviation
      • DistributionInverseCumulative
      • DistributionInverseDensity
      • DistributionKurtosis
      • DistributionMean
      • DistributionSkewness
      • DistributionVariance
      • Combination
      • Factorial
      • Permutation
    • Histogram Functions
      • HistogramAddObservation
      • HistogramAddObservations
      • HistogramCreate
      • HistogramDelete
      • HistogramGetAverage
      • HistogramGetBounds
      • HistogramGetDeviation
      • HistogramGetFrequencies
      • HistogramGetKurtosis
      • HistogramGetObservationCount
      • HistogramGetSkewness
      • HistogramSetDomain
  • Algorithmic Capabilities
    • Constraint Programming Functions
      • cp::AllDifferent
      • cp::BinPacking
      • cp::Cardinality
      • cp::Channel
      • cp::Count
      • cp::Lexicographic
      • cp::ParallelSchedule
      • cp::Sequence
      • cp::SequentialSchedule
    • Scheduling Functions
      • cp::ActivityBegin
      • cp::ActivityEnd
      • cp::ActivityLength
      • cp::ActivitySize
      • cp::Alternative
      • cp::BeginAtBegin
      • cp::BeginAtEnd
      • cp::BeginBeforeBegin
      • cp::BeginBeforeEnd
      • cp::BeginOfNext
      • cp::BeginOfPrevious
      • cp::EndAtBegin
      • cp::EndAtEnd
      • cp::EndBeforeBegin
      • cp::EndBeforeEnd
      • cp::EndOfNext
      • cp::EndOfPrevious
      • cp::GroupOfNext
      • cp::GroupOfPrevious
      • cp::LengthOfNext
      • cp::LengthOfPrevious
      • cp::SizeOfNext
      • cp::SizeOfPrevious
      • cp::Span
      • cp::Synchronize
    • The GMP Library
      • GMP::Benders Procedures and Functions
        • GMP::Benders::AddFeasibilityCut
        • GMP::Benders::AddOptimalityCut
        • GMP::Benders::CreateMasterProblem
        • GMP::Benders::CreateSubProblem
        • GMP::Benders::UpdateSubProblem
      • GMP::Coefficient Procedures and Functions
        • GMP::Coefficient::Get
        • GMP::Coefficient::GetMinAndMax
        • GMP::Coefficient::GetRaw
        • GMP::Coefficient::GetQuadratic
        • GMP::Coefficient::Set
        • GMP::Coefficient::SetMulti
        • GMP::Coefficient::SetQuadratic
        • GMP::Coefficient::SetRaw
      • GMP::Column Procedures and Functions
        • GMP::Column::Add
        • GMP::Column::AddMulti
        • GMP::Column::Delete
        • GMP::Column::DeleteMulti
        • GMP::Column::DeleteRaw
        • GMP::Column::Freeze
        • GMP::Column::FreezeMulti
        • GMP::Column::FreezeRaw
        • GMP::Column::GetLowerBound
        • GMP::Column::GetLowerBoundRaw
        • GMP::Column::GetName
        • GMP::Column::GetScale
        • GMP::Column::GetStatus
        • GMP::Column::GetType
        • GMP::Column::GetUpperBound
        • GMP::Column::GetUpperBoundRaw
        • GMP::Column::SetAsMultiObjective
        • GMP::Column::SetAsObjective
        • GMP::Column::SetDecomposition
        • GMP::Column::SetDecompositionMulti
        • GMP::Column::SetLowerBound
        • GMP::Column::SetLowerBoundMulti
        • GMP::Column::SetLowerBoundRaw
        • GMP::Column::SetType
        • GMP::Column::SetTypeMulti
        • GMP::Column::SetTypeRaw
        • GMP::Column::SetUpperBound
        • GMP::Column::SetUpperBoundMulti
        • GMP::Column::SetUpperBoundRaw
        • GMP::Column::Unfreeze
        • GMP::Column::UnfreezeMulti
        • GMP::Column::UnfreezeRaw
      • GMP::Event Procedures and Functions
        • GMP::Event::Create
        • GMP::Event::Delete
        • GMP::Event::Reset
        • GMP::Event::Set
      • GMP::Instance Procedures and Functions
        • GMP::Instance::AddIntegerEliminationRows
        • GMP::Instance::AddLimitBinaryDeviationRow
        • GMP::Instance::CalculateSubGradient
        • GMP::Instance::Copy
        • GMP::Instance::CreateBlockMatrices
        • GMP::Instance::CreateDual
        • GMP::Instance::CreateFeasibility
        • GMP::Instance::CreateMasterMIP
        • GMP::Instance::CreatePresolved
        • GMP::Instance::CreateProgressCategory
        • GMP::Instance::CreateSolverSession
        • GMP::Instance::Delete
        • GMP::Instance::DeleteIntegerEliminationRows
        • GMP::Instance::DeleteLimitBinaryDeviationRow
        • GMP::Instance::DeleteMultiObjectives
        • GMP::Instance::DeleteSolverSession
        • GMP::Instance::FindApproximatelyFeasibleSolution
        • GMP::Instance::FixColumns
        • GMP::Instance::Generate
        • GMP::Instance::GenerateRobustCounterpart
        • GMP::Instance::GenerateStochasticProgram
        • GMP::Instance::GetAttributeValue
        • GMP::Instance::GetBestBound
        • GMP::Instance::GetColumnNumbers
        • GMP::Instance::GetDirection
        • GMP::Instance::GetInfeasibleData
        • GMP::Instance::GetMathematicalProgrammingType
        • GMP::Instance::GetMemoryUsed
        • GMP::Instance::GetNumberOfColumns
        • GMP::Instance::GetNumberOfIndicatorRows
        • GMP::Instance::GetNumberOfIntegerColumns
        • GMP::Instance::GetNumberOfNonlinearColumns
        • GMP::Instance::GetNumberOfNonlinearNonzeros
        • GMP::Instance::GetNumberOfNonlinearRows
        • GMP::Instance::GetNumberOfNonzeros
        • GMP::Instance::GetNumberOfRows
        • GMP::Instance::GetNumberOfSOS1Rows
        • GMP::Instance::GetNumberOfSOS2Rows
        • GMP::Instance::GetObjective
        • GMP::Instance::GetObjectiveColumnNumber
        • GMP::Instance::GetObjectiveRowNumber
        • GMP::Instance::GetOptionValue
        • GMP::Instance::GetRowNumbers
        • GMP::Instance::GetSolver
        • GMP::Instance::GetSymbolicMathematicalProgram
        • GMP::Instance::MemoryStatistics
        • GMP::Instance::Rename
        • GMP::Instance::RestoreState
        • GMP::Instance::SaveState
        • GMP::Instance::SetCallbackAddCut
        • GMP::Instance::SetCallbackAddLazyConstraint
        • GMP::Instance::SetCallbackBranch
        • GMP::Instance::SetCallbackCandidate
        • GMP::Instance::SetCallbackHeuristic
        • GMP::Instance::SetCallbackIncumbent
        • GMP::Instance::SetCallbackIterations
        • GMP::Instance::SetCallbackStatusChange
        • GMP::Instance::SetCallbackTime
        • GMP::Instance::SetCutoff
        • GMP::Instance::SetDirection
        • GMP::Instance::SetIterationLimit
        • GMP::Instance::SetMathematicalProgrammingType
        • GMP::Instance::SetMemoryLimit
        • GMP::Instance::SetOptionValue
        • GMP::Instance::SetSolver
        • GMP::Instance::SetStartingPointSelection
        • GMP::Instance::SetTimeLimit
        • GMP::Instance::Solve
      • GMP::Linearization Procedures and Functions
        • GMP::Linearization::Add
        • GMP::Linearization::AddSingle
        • GMP::Linearization::Delete
        • GMP::Linearization::GetDeviation
        • GMP::Linearization::GetDeviationBound
        • GMP::Linearization::GetLagrangeMultiplier
        • GMP::Linearization::GetType
        • GMP::Linearization::GetWeight
        • GMP::Linearization::RemoveDeviation
        • GMP::Linearization::SetDeviationBound
        • GMP::Linearization::SetType
        • GMP::Linearization::SetWeight
      • GMP::ProgressWindow Procedures and Functions
        • GMP::ProgressWindow::DeleteCategory
        • GMP::ProgressWindow::DisplayLine
        • GMP::ProgressWindow::DisplayProgramStatus
        • GMP::ProgressWindow::DisplaySolver
        • GMP::ProgressWindow::DisplaySolverStatus
        • GMP::ProgressWindow::FreezeLine
        • GMP::ProgressWindow::Transfer
        • GMP::ProgressWindow::UnfreezeLine
      • GMP::QuadraticCoefficient Procedures and Functions
        • GMP::QuadraticCoefficient::Get
        • GMP::QuadraticCoefficient::Set
      • GMP::Robust Procedures and Functions
        • GMP::Robust::EvaluateAdjustableVariables
      • GMP::Row Procedures and Functions
        • GMP::Row::Activate
        • GMP::Row::ActivateMulti
        • GMP::Row::ActivateRaw
        • GMP::Row::Add
        • GMP::Row::AddMulti
        • GMP::Row::Deactivate
        • GMP::Row::DeactivateMulti
        • GMP::Row::DeactivateRaw
        • GMP::Row::Delete
        • GMP::Row::DeleteIndicatorCondition
        • GMP::Row::DeleteMulti
        • GMP::Row::DeleteRaw
        • GMP::Row::Generate
        • GMP::Row::GenerateMulti
        • GMP::Row::GetConvex
        • GMP::Row::GetIndicatorColumn
        • GMP::Row::GetIndicatorCondition
        • GMP::Row::GetLeftHandSide
        • GMP::Row::GetName
        • GMP::Row::GetRelaxationOnly
        • GMP::Row::GetRightHandSide
        • GMP::Row::GetRightHandSideRaw
        • GMP::Row::GetScale
        • GMP::Row::GetStatus
        • GMP::Row::GetType
        • GMP::Row::SetConvex
        • GMP::Row::SetIndicatorCondition
        • GMP::Row::SetLeftHandSide
        • GMP::Row::SetPoolType
        • GMP::Row::SetPoolTypeMulti
        • GMP::Row::SetRelaxationOnly
        • GMP::Row::SetRightHandSide
        • GMP::Row::SetRightHandSideMulti
        • GMP::Row::SetRightHandSideRaw
        • GMP::Row::SetType
        • GMP::Row::SetTypeMulti
        • GMP::Row::SetTypeRaw
      • GMP::Solution Procedures and Functions
        • GMP::Solution::Check
        • GMP::Solution::ConstraintListing
        • GMP::Solution::ConstructMean
        • GMP::Solution::Copy
        • GMP::Solution::Count
        • GMP::Solution::Delete
        • GMP::Solution::DeleteAll
        • GMP::Solution::GetBestBound
        • GMP::Solution::GetColumnValue
        • GMP::Solution::GetDistance
        • GMP::Solution::GetFirstOrderDerivative
        • GMP::Solution::GetIterationsUsed
        • GMP::Solution::GetMemoryUsed
        • GMP::Solution::GetNodesUsed
        • GMP::Solution::GetObjective
        • GMP::Solution::GetPenalizedObjective
        • GMP::Solution::GetProgramStatus
        • GMP::Solution::GetRowValue
        • GMP::Solution::GetSolutionsSet
        • GMP::Solution::GetSolverStatus
        • GMP::Solution::GetTimeUsed
        • GMP::Solution::IsDualDegenerated
        • GMP::Solution::IsInteger
        • GMP::Solution::IsPrimalDegenerated
        • GMP::Solution::Move
        • GMP::Solution::RandomlyGenerate
        • GMP::Solution::RetrieveFromModel
        • GMP::Solution::RetrieveFromSolverSession
        • GMP::Solution::SendToModel
        • GMP::Solution::SendToModelSelection
        • GMP::Solution::SendToSolverSession
        • GMP::Solution::SetColumnValue
        • GMP::Solution::SetIterationCount
        • GMP::Solution::SetMIPStartFlag
        • GMP::Solution::SetObjective
        • GMP::Solution::SetProgramStatus
        • GMP::Solution::SetRowValue
        • GMP::Solution::SetSolverStatus
        • GMP::Solution::UpdatePenaltyWeights
      • GMP::Solver Procedures and Functions
        • GMP::Solver::FreeEnvironment
        • GMP::Solver::GetAsynchronousSessionsLimit
        • GMP::Solver::InitializeEnvironment
        • GMP::Solver::SetEnvironmentDoubleParameter
        • GMP::Solver::SetEnvironmentIntegerParameter
        • GMP::Solver::SetEnvironmentStringParameter
      • GMP::SolverSession Procedures and Functions
        • GMP::SolverSession::AddBendersFeasibilityCut
        • GMP::SolverSession::AddBendersOptimalityCut
        • GMP::SolverSession::AddLinearization
        • GMP::SolverSession::AsynchronousExecute
        • GMP::SolverSession::CreateProgressCategory
        • GMP::SolverSession::Execute
        • GMP::SolverSession::ExecutionStatus
        • GMP::SolverSession::GenerateBinaryEliminationRow
        • GMP::SolverSession::GenerateBranchLowerBound
        • GMP::SolverSession::GenerateBranchRow
        • GMP::SolverSession::GenerateBranchUpperBound
        • GMP::SolverSession::GenerateCut
        • GMP::SolverSession::GetAttributeValue
        • GMP::SolverSession::GetBestBound
        • GMP::SolverSession::GetCallbackInterruptStatus
        • GMP::SolverSession::GetCandidateObjective
        • GMP::SolverSession::GetIIS
        • GMP::SolverSession::GetInstance
        • GMP::SolverSession::GetIterationsUsed
        • GMP::SolverSession::GetMemoryUsed
        • GMP::SolverSession::GetNodeNumber
        • GMP::SolverSession::GetNodeObjective
        • GMP::SolverSession::GetNodesLeft
        • GMP::SolverSession::GetNodesUsed
        • GMP::SolverSession::GetNumberOfBranchNodes
        • GMP::SolverSession::GetObjective
        • GMP::SolverSession::GetOptionValue
        • GMP::SolverSession::GetProgramStatus
        • GMP::SolverSession::GetSolver
        • GMP::SolverSession::GetSolverStatus
        • GMP::SolverSession::GetTimeUsed
        • GMP::SolverSession::Interrupt
        • GMP::SolverSession::RejectIncumbent
        • GMP::SolverSession::SetObjective
        • GMP::SolverSession::SetOptionValue
        • GMP::SolverSession::Transfer
        • GMP::SolverSession::WaitForCompletion
        • GMP::SolverSession::WaitForSingleCompletion
      • GMP::Stochastic Procedures and Functions
        • GMP::Stochastic::AddBendersFeasibilityCut
        • GMP::Stochastic::AddBendersOptimalityCut
        • GMP::Stochastic::BendersFindFeasibilityReference
        • GMP::Stochastic::BendersFindReference
        • GMP::Stochastic::CreateBendersRootproblem
        • GMP::Stochastic::GetObjectiveBound
        • GMP::Stochastic::GetRelativeWeight
        • GMP::Stochastic::GetRepresentativeScenario
        • GMP::Stochastic::MergeSolution
        • GMP::Stochastic::UpdateBendersSubproblem
      • GMP::Tuning Procedures and Functions
        • GMP::Tuning::SolveSingleMPS
        • GMP::Tuning::TuneMultipleMPS
        • GMP::Tuning::TuneSingleGMP
    • Miscellaneous Functions
      • GenerateCut
      • RetrieveCurrentVariableValues
  • Model Handling
    • Model Query Functions
      • AttributeToString
      • AttributeLength
      • AttributeContainsString
      • CallerAttribute
      • CallerLine
      • CallerNode
      • CallerNumberOfLocations
      • ConstraintVariables
      • DeclaredSubset
      • DomainIndex
      • GetAnnotationValues
      • IdentifierAttributes
      • IdentifierDimension
      • IdentifierElementRange
      • IdentifierText
      • IdentifierType
      • IdentifierUnit
      • IndexRange
      • IdentifierShowAttributes
      • IdentifierShowTreeLocation
      • IsRuntimeIdentifier
      • ReferencedIdentifiers
      • SectionIdentifiers
      • VariableConstraints
    • Model Edit Functions
      • me::AllowedAttribute
      • me::ChangeType
      • me::ChangeTypeAllowed
      • me::Children
      • me::ChildTypeAllowed
      • me::Compile
      • me::Create
      • me::CreateLibrary
      • me::Delete
      • me::ExportNode
      • me::GetAttribute
      • me::ImportLibrary
      • me::ImportNode
      • me::IsRunnable
      • me::Move
      • me::Parent
      • me::Rename
      • me::SetAnnotation
      • me::SetAttribute
  • Data Management
    • Case Management
      • CaseFileLoad
      • CaseCompareIdentifier
      • CaseFileMerge
      • CaseFileSave
      • CaseCreateDifferenceFile
      • CaseFileGetContentType
      • CaseFileSectionExists
      • CaseFileSectionGetContentType
      • CaseFileSectionLoad
      • CaseFileSectionMerge
      • CaseFileSectionRemove
      • CaseFileSectionSave
      • CaseCommandLoadAsActive
      • CaseFileSetCurrent
      • CaseFileURLtoElement
      • CaseCommandLoadIntoActive
      • CaseCommandMergeIntoActive
      • CaseCommandNew
      • CaseCommandSave
      • CaseCommandSaveAs
      • CaseDialogConfirmAndSave
      • CaseDialogSelectForLoad
      • CaseDialogSelectForSave
      • CaseDialogSelectMultiple
      • DataManagementExit
    • Data Change Monitor Functions
      • DataChangeMonitorCreate
      • DataChangeMonitorDelete
      • DataChangeMonitorHasChanged
      • DataChangeMonitorReset
    • Database Functions
      • CloseDataSource
      • CommitTransaction
      • DirectSQL
      • LoadDatabaseStructure
      • RollbackTransaction
      • SaveDatabaseStructure
      • StartTransaction
      • TestDataSource
      • TestDatabaseTable
      • GetDataSourceProperty
      • SQLNumberOfColumns
      • TestDatabaseColumn
      • SQLNumberOfDrivers
      • SQLNumberOfTables
      • SQLNumberOfViews
      • SQLColumnData
      • SQLDriverName
      • SQLCreateConnectionString
      • SQLTableName
      • SQLViewName
    • Spreadsheet Functions
      • Spreadsheet::ColumnName
      • Spreadsheet::ColumnNumber
      • Spreadsheet::SetActiveSheet
      • Spreadsheet::SetVisibility
      • Spreadsheet::AssignValue
      • Spreadsheet::SetOption
      • Spreadsheet::SetUpdateLinksBehavior
      • Spreadsheet::AssignSet
      • Spreadsheet::RetrieveSet
      • Spreadsheet::RetrieveValue
      • Spreadsheet::AssignParameter
      • Spreadsheet::RetrieveParameter
      • Spreadsheet::AssignTable
      • Spreadsheet::ClearRange
      • Spreadsheet::RetrieveTable
      • Spreadsheet::AddNewSheet
      • Spreadsheet::CopyRange
      • Spreadsheet::DeleteSheet
      • Spreadsheet::GetAllSheets
      • Spreadsheet::RunMacro
      • Spreadsheet::CloseWorkbook
      • Spreadsheet::CreateWorkbook
      • Spreadsheet::SaveWorkbook
      • Spreadsheet::Print
    • XML Functions
      • GenerateXML
      • ReadGeneratedXML
      • ReadXML
      • WriteXML
  • User Interface Related Functions
    • Dialog Functions
      • DialogAsk
      • DialogError
      • DialogGetColor
      • DialogGetDate
      • DialogGetElement
      • DialogGetElementByData
      • DialogGetElementByText
      • DialogGetNumber
      • DialogGetPassword
      • DialogGetString
      • DialogMessage
      • DialogProgress
      • StatusMessage
    • Page Functions
      • PageClose
      • PageCopyTableToClipboard
      • PageCopyTableToExcel
      • PageGetActive
      • PageGetAll
      • PageGetChild
      • PageGetFocus
      • PageGetNext
      • PageGetNextInTreeWalk
      • PageGetParent
      • PageGetPrevious
      • PageGetTitle
      • PageGetUsedIdentifiers
      • PageOpen
      • PageOpenSingle
      • PageRefreshAll
      • PageSetCursor
      • PageSetFocus
      • PivotTableDeleteState
      • PivotTableReloadState
      • PivotTableSaveState
      • PrintEndReport
      • PrintPage
      • PrintPageCount
      • PrinterGetCurrentName
      • PrintStartReport
      • PrinterSetupDialog
      • ShowMessageWindow
      • ShowProgressWindow
    • User Colors
      • UserColorAdd
      • UserColorDelete
      • UserColorGetRGB
      • UserColorModify
  • Development Support
    • Profiler and Debugger
      • DebuggerBreakPoint
      • ProfilerPause
      • ProfilerStart
      • ProfilerContinue
      • ProfilerRestart
      • ProfilerCollectAllData
    • Application Information
      • IdentifierGetUsedInformation
      • IdentifierMemory
      • IdentifierMemoryStatistics
      • MemoryInUse
      • MemoryStatistics
      • ShowHelpTopic
  • System Interaction
    • Error Handling Functions
      • errh::Adapt
      • errh::Attribute
      • errh::Category
      • errh::Code
      • errh::Column
      • errh::CreationTime
      • errh::Filename
      • errh::InsideCategory
      • errh::IsMarkedAsHandled
      • errh::Line
      • errh::MarkAsHandled
      • errh::Message
      • errh::Multiplicity
      • errh::Node
      • errh::NumberOfLocations
      • errh::Severity
    • Option Manipulation
      • OptionGetDefaultString
      • OptionGetKeywords
      • OptionGetString
      • OptionGetValue
      • OptionSetString
      • OptionSetValue
    • Licensing Functions
      • LicenseExpirationDate
      • LicenseMaintenanceExpirationDate
      • LicenseNumber
      • LicenseStartDate
      • LicenseType
      • ProjectDeveloperMode
      • SecurityGetGroups
      • SecurityGetUsers
      • SolverGetControl
      • SolverReleaseControl
    • Environment Functions
      • AimmsRevisionString
      • EnvironmentGetString
      • EnvironmentSetString
      • GeoFindCoordinates
      • TestInternetConnection
    • Invoking Actions
      • Delay
      • Execute
      • ExitAimms
      • OpenDocument
      • ScheduleAt
      • SessionArgument
    • File and Directory Functions
      • DirectoryCopy
      • DirectoryCreate
      • DirectoryDelete
      • DirectoryExists
      • DirectoryGetCurrent
      • DirectoryGetFiles
      • DirectoryGetSubdirectories
      • DirectoryMove
      • DirectoryOfLibraryProject
      • DirectorySelect
      • FileAppend
      • FileCopy
      • FileDelete
      • FileEdit
      • FileExists
      • FileGetSize
      • FileMove
      • FilePrint
      • FileRead
      • FileSelect
      • FileSelectNew
      • FileTime
      • FileTouch
      • FileView
  • Predefined Identifiers
    • System Settings Related Identifiers
      • AllAuthorizationLevels
      • AllAvailableCharacterEncodings
      • ASCIICharacterEncodings
      • ASCIIUnicodeCharacterEncodings
      • UnicodeCharacterEncodings
      • AllCharacterEncodings
      • AllColors
      • AllIntrinsics
      • AllKeywords
      • AllOptions
      • AllPredeclaredIdentifiers
      • AllSolvers
      • AllSymbols
      • CurrentAuthorizationLevel
      • ProfilerData
      • CurrentGroup
      • CurrentSolver
      • AimmsStringConstants
      • AllAimmsStringConstantElements
      • CurrentUser
    • Language Related Identifiers
      • AggregationTypes
      • AllAttributeNames
      • AllBasicValues
      • AllCaseComparisonModes
      • AllColumnTypes
      • AllDataColumnCharacteristics
      • AllDataSourceProperties
      • AllDifferencingModes
      • AllExecutionStatuses
      • AllGMPExtensions
      • AllFileAttributes
      • AllIdentifierTypes
      • AllIsolationLevels
      • AllMathematicalProgrammingTypes
      • AllMatrixManipulationDirections
      • AllMatrixManipulationProgrammingTypes
      • AllProfilerTypes
      • AllConstraintProgrammingRowTypes
      • AllRowColumnStatuses
      • AllRowTypes
      • AllMathematicalProgrammingRowTypes
      • AllSolutionStates
      • AllSolverInterrupts
      • AllStochasticGenerationModes
      • AllSuffixNames
      • AllValueKeywords
      • AllViolationTypes
      • ContinueAbort
      • DiskWindowVoid
      • Integers
      • MaximizingMinimizing
      • MergeReplace
      • OnOff
      • TimeSlotCharacteristics
      • YesNo
    • Model Related Identifiers
      • AllAssertions
      • AllConstraints
      • AllConventions
      • AllDatabaseTables
      • AllDefinedParameters
      • AllDefinedSets
      • AllFiles
      • AllFunctions
      • AllGMPEvents
      • AllIdentifiers
      • AllIndices
      • AllIntegerVariables
      • AllMacros
      • AllMathematicalPrograms
      • AllNonLinearConstraints
      • AllParameters
      • AllProcedures
      • AllQuantities
      • AllSections
      • AllSets
      • AllSolverSessionCompletionObjects
      • AllSolverSessions
      • AllStochasticConstraints
      • AllStochasticParameters
      • AllStochasticVariables
      • AllUpdatableIdentifiers
      • AllVariables
      • AllVariablesConstraints
    • Execution State Related Identifiers
      • AllGeneratedMathematicalPrograms
      • AllProgressCategories
      • AllStochasticScenarios
      • CurrentAutoUpdatedDefinitions
      • CurrentErrorMessage
      • CurrentFile
      • CurrentFileName
      • CurrentInputs
      • CurrentMatrixBlockSizes
      • CurrentMatrixColumnCount
      • CurrentMatrixRowCount
      • CurrentPageNumber
      • ODBCDateTimeFormat
    • Case Management Related Identifiers
      • AllCases
      • AllCaseTypes
      • AllDataCategories
      • AllDataFiles
      • AllDataSets
      • CurrentCase
      • CurrentCaseSelection
      • CurrentDataSet
      • AllCaseFileContentTypes
      • CurrentCaseFileContentType
      • CurrentDefaultCaseType
      • CaseFileURL
    • Date-Time Related Identifiers
      • AllAbbrMonths
      • AllAbbrWeekdays
      • AllMonths
      • AllTimeZones
      • AllWeekdays
      • LocaleAllAbbrMonths
      • LocaleAllAbbrWeekdays
      • LocaleAllMonths
      • LocaleAllWeekdays
      • LocaleLongDateFormat
      • LocaleShortDateFormat
      • LocaleTimeFormat
      • LocaleTimeZoneName
      • LocaleTimeZoneNameDST
    • Error Handling Related Identifiers
      • errh::ErrorCodes
      • errh::PendingErrors
      • errh::AllErrorCategories
      • errh::AllErrorSeverities
  • Suffices
    • Common Suffices
      • .dim
      • .txt
      • .type
      • .unit
    • Horizon Suffices
      • .beyond
      • .past
      • .planning
    • Variable and Constraint Suffices
      • .Basic
      • .Level
      • .Lower
      • .Stochastic
      • .Upper
      • .Violation
      • .ExtendedConstraint
      • .ExtendedVariable
    • Variable Suffices
      • .ReducedCost
      • .Nonvar
      • .Relax
      • .Complement
      • .DefinitionViolation
      • .Derivative
      • .Priority
      • .SmallestCoefficient
      • .LargestCoefficient
      • .NominalCoefficient
      • .SmallestValue
      • .LargestValue
    • Constraint Suffices
      • .Convex
      • .ShadowPrice
      • .RelaxationOnly
      • .SmallestShadowPrice
      • .LargestShadowPrice
      • .SmallestRightHandSide
      • .LargestRightHandSide
      • .NominalRightHandSide
    • Mathematical Program Suffices
      • .bratio
      • .cutoff
      • .domlim
      • .iterlim
      • .limrow
      • .nodlim
      • .optca
      • .optcr
      • .reslim
      • .tolinfrep
      • .workspace
      • .ProgramStatus
      • .SolverCalls
      • .SolverStatus
      • .Incumbent
      • .Objective
      • .BestBound
      • .Nodes
      • .GenTime
      • .Iterations
      • .SolutionTime
      • .NumberOfBranches
      • .NumberOfConstraints
      • .NumberOfFails
      • .NumberOfInfeasibilities
      • .SumOfInfeasibilities
      • .NumberOfNonzeros
      • .NumberOfVariables
      • .CallbackIterations
      • .CallbackProcedure
      • .CallbackStatusChange
      • .CallbackTime
      • .CallbackIncumbent
      • .CallbackReturnStatus
      • .CallbackAddCut
    • File Suffices
      • .Ap
      • .blank_zeros
      • .case
      • .PageMode
      • .PageNumber
      • .PageSize
      • .PageWidth
      • .TopMargin
      • .BottomMargin
      • .LeftMargin
      • .BodyCurrentColumn
      • .BodyCurrentRow
      • .BodySize
      • .FooterCurrentColumn
      • .FooterCurrentRow
      • .FooterSize
      • .HeaderCurrentColumn
      • .HeaderCurrentRow
      • .HeaderSize
      • .lj
      • .lw
      • .nd
      • .nj
      • .nr
      • .nw
      • .nz
      • .sj
      • .sw
      • .tf
      • .tj
      • .tw
  • Deprecated
    • Deprecated Language Elements
    • Matrix Manipulation Procedures
    • Data Management via a Single Data Manager File
      • Cases
        • CaseCreate
        • CaseDelete
        • CaseFind
        • CaseGetChangedStatus
        • CaseGetDatasetReference
        • CaseGetType
        • CaseLoadCurrent
        • CaseLoadIntoCurrent
        • CaseMerge
        • CaseNew
        • CaseSave
        • CaseSaveAll
        • CaseSaveAs
        • CaseSelect
        • CaseSelectMultiple
        • CaseSelectNew
        • CaseReadFromSingleFile
        • CaseSetChangedStatus
        • CaseSetCurrent
        • CaseWriteToSingleFile
      • Datasets
        • DatasetCreate
        • DatasetDelete
        • DatasetFind
        • DatasetGetCategory
        • DatasetGetChangedStatus
        • DatasetLoadCurrent
        • DatasetLoadIntoCurrent
        • DatasetMerge
        • DatasetNew
        • DatasetSave
        • DatasetSaveAll
        • DatasetSaveAs
        • DatasetSelect
        • DatasetSelectNew
        • DatasetSetChangedStatus
        • DatasetSetCurrent
      • Data Manager Files
        • CaseTypeCategories
        • CaseTypeContents
        • DataCategoryContents
        • DataFileCopy
        • DataFileExists
        • DataFileGetAcronym
        • DataFileGetComment
        • DataFileGetDescription
        • DataFileGetGroup
        • DataFileGetName
        • DataFileGetOwner
        • DataFileGetPath
        • DataFileGetTime
        • DataFileReadPermitted
        • DataFileSetAcronym
        • DataFileSetComment
        • DataFileWritePermitted
        • DataImport220
        • DataManagerFileNew
        • DataManagerFileOpen
        • DataManagerExport
        • DataManagerFileGetCurrent
        • DataManagerImport
    • Deprecated AIMMS 220 Functions
      • ListingFileCopy
      • ListingFileDelete
AIMMS Function Reference
AIMMS Logo
  • Function Reference »
  • Deprecated »
  • Data Management via a Single Data Manager File »
  • Cases
  • Edit on Github

Cases

  • CaseCreate
  • CaseDelete
  • CaseFind
  • CaseGetChangedStatus
  • CaseGetDatasetReference
  • CaseGetType
  • CaseLoadCurrent
  • CaseLoadIntoCurrent
  • CaseMerge
  • CaseNew
  • CaseSave
  • CaseSaveAll
  • CaseSaveAs
  • CaseSelect
  • CaseSelectMultiple
  • CaseSelectNew
  • CaseReadFromSingleFile
  • CaseSetChangedStatus
  • CaseSetCurrent
  • CaseWriteToSingleFile
Last updated: Aug 08, 2025

Help & Feedback

Docs

Edit this page to fix an error or add an improvement in a pull request
Create an issue to suggest an improvement to this page

Product

Create a topic if there's something you don't like about this feature
Propose functionality by submitting a feature request

Support

Not what you where looking for? Search the docs

Remember we also have Community support

Still having trouble ? Reach out to us


Next Previous

AIMMS
AIMMS COMMUNITY
AIMMS DOCS
DISCLAIMER
PRIVACY STATEMENT
© 1989 - 2025 AIMMS B.V.