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::DeleteSheet(Workbook, Name)

Spreadsheet::DeleteSheet

The procedure Spreadsheet::DeleteSheet deletes the given sheet from the specified Excel or OpenOffice Calc workbook.

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

Name

The name of the sheet to be deleted.

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

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