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::AssignSet(Workbook, Set, Range, Sheet)

Spreadsheet::AssignSet

The procedure Spreadsheet::AssignSet writes the elements of an AIMMS set into the given range of an Excel or OpenOffice Calc workbook.

Spreadsheet::AssignSet(
        Workbook,       ! (input) scalar string expression
        Set,            ! (input) set 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.

Set

The AIMMS set to be written to the spreadsheet.

Range

A scalar string expression containing the range in the sheet to which the Set should be written.

Sheet

The sheet to which the Set should be written. 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 ExcelAssignSet, which has become deprecated as of AIMMS 3.12.