excelRemoveSheet
Syntax | excelRemoveSheet(workbookFID, worksheet_name) | Package | excel |
Alias |
| Pkg Usage | removeSheet(workbookFID, worksheet_name) |
Description
Removes the selected sheet from an open workbook.
Parameters
Parameter name | Type | Required | Description |
|---|---|---|---|
workbookFID | Integer | Yes | The file id of the open workbook. The file id is returned from running the excelOpenWorkbook() routine. |
worksheet_name | String | Yes | The name of the worksheet to be deleted |
Return Type
Boolean
Returns true if the operation was successful, false otherwise.
Example
Opens a workbook, deletes a sheet and then saves and closes the workbook.
use "excel";
int fid = openWorkbook("snakes.xlsx");
removeSheet(fid, "Venemous Snakes", 4);
closeWorkbook(fid);Result: The 'Venemous Snakes' sheet will be removed.
Click here to download the workbook used in this example.
See also
Need support? Create a request with our support team.
Copyright © 2005 - 2025 Appfire | All rights reserved.