ExcelRpt_WorksheetNew
- Updated2023-02-21
- 1 minute(s) read
HRESULT ExcelRpt_WorksheetNew (CAObjHandle workbookHandle, int insertBeforeIndex, CAObjHandle *worksheetHandle);
Purpose
Creates a new worksheet in the workbook.
Parameters
| Input | ||
| Name | Type | Description |
| workbookHandle | CAObjHandle | A handle to an Excel Workbook object. |
| insertBeforeIndex | int | The new sheet will be placed before the current worksheet with this index. This index is 1–based. Pass –1 to insert the new sheet after the last worksheet. |
| Output | ||
| Name | Type | Description |
| worksheetHandle | CAObjHandle | A handle to the new Excel Worksheet object. When it is no longer needed, this handle must be discarded using CA_DiscardObjHandle. |
Return Value
| Name | Type | Description |
| status | HRESULT | A value indicating whether an error occurred. Function failure is indicated by a negative error code. Error codes are defined in CVIversion\include\cviauto.h and <Program Files>\National Instruments\Shared\MSDTRedistributables\SDKHeaderFiles\8.1\winerror.h. You can use CA_GetAutomationErrorString to get the description of an error code. |
Additional Information
Library: Excel Report
Include file: activex\excel\ExcelReport.h
LabWindows/CVI compatibility: LabWindows/CVI 7.0 and later