ExcelRpt_GetSheetTypeFromIndex
HRESULT ExcelRpt_GetSheetTypeFromIndex (CAObjHandle workbookHandle, int index, enum ExREnum_ExSheetType *sheetType);
Purpose
Gets the sheet type (either worksheet or chartsheet) given the index of the sheet in the workbook.
Parameters
| Input | ||||||
| Name | Type | Description | ||||
| workbookHandle | CAObjHandle | A handle to an Excel Workbook object. | ||||
| index | int | The 1-based index of the desired sheet in the workbook. | ||||
| Output | ||||||
| Name | Type | Description | ||||
| sheetType | enum ExREnum_ExSheetType | The sheet type will be one of the following ExREnum_ExSheetType constants:
|
||||
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