Warning

This article references outdated technology and is provided for historical purposes only. It is not recommended to use this information as a primary source for current projects or documentation. Please refer to the latest documentation for up-to-date information, see more in: AIMMSXL Library and the Data Exchange Library.

Procedure Spreadsheet::RetrieveValue(Workbook, Parameter, Range, Sheet)

Spreadsheet::RetrieveValue

The procedure Spreadsheet::RetrieveValue reads the value of an Excel or OpenOffice Calc cell into a scalar AIMMS parameter.

Spreadsheet::RetrieveValue(
        Workbook,       ! (input) scalar string expression
        Parameter,      ! (output) scalar identifier
        Range,          ! (input) scalar string expression
        [Sheet]         ! (optional) scalar string expression
        )

Arguments

Workbook

A scalar string expression representing the Excel or Calc workbook. If this argument ends in .ods, OpenOffice Calc is used. Otherwise, Excel is used.

Parameter

A scalar numerical parameter, string parameter, element parameter or unit parameter to which the value from the Range will be written.

Range

A scalar string expression containing a reference to the cell in the sheet from which the value will be read.

Sheet

The sheet from which the value should be read. Default is the active sheet.

Return Value

The procedure returns 1 on success, or 0 otherwise. In case of an error the pre-defined AIMMS parameter CurrentErrorMessage contains a description of what went wrong.

Note

• By calling the procedure Spreadsheet::SetActiveSheet you can set the active sheet, after which the optional sheet argument can be omitted in procedures like this one.

• A call to this procedure with a specified sheet argument does not change the active sheet, except when the workbook does not have an active sheet yet.

• Upto AIMMS 3.11 this function was known as ExcelRetrieveValue, which has become deprecated as of AIMMS 3.12.