Procedure Spreadsheet::GetAllSheets(Workbook, Name)

Spreadsheet::GetAllSheets

Warning

Spreadsheet Functions are deprecated. One may use the AIMMS Excel Library - AXLL or the Data Exchange Library.

The procedure Spreadsheet::GetAllSheets obtains the names of all sheets currently present in the specified Excel or OpenOffice Calc workbook.

Spreadsheet::GetAllSheets(
        Workbook,       ! (input) scalar string expression
        SheetNames      ! (input) 1-dimensional 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

Name

A 1-dimensional string parameter, which after successful execution will contain all present sheet names of the supplied workbook. The root set of the index should be a subset of Integers.

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

None.