ExcelRpt_GetEmbeddedChartFromIndex
- Updated2023-02-21
- 1 minute(s) read
HRESULT ExcelRpt_GetEmbeddedChartFromIndex (CAObjHandle worksheetHandle, int index, CAObjHandle *chartHandle);
Purpose
Gets the handle of a chart embedded in a worksheet given an index.
Parameters
| Input | ||
| Name | Type | Description |
| worksheetHandle | CAObjHandle | A handle to an Excel Worksheet object. |
| index | int | The 1–based index of the desired embedded chart in the workbook. |
| Output | ||
| Name | Type | Description |
| chartHandle | CAObjHandle | A handle to the new Excel Chart 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