ExcelRpt_GetCellValueStringLen
- Updated2023-02-21
- 1 minute(s) read
HRESULT ExcelRpt_GetCellValueStringLen (CAObjHandle worksheetHandle, char cellRange[], int *length);
Purpose
Gets the length of the string needed to hold the contents of the cell.
Parameters
| Input | ||
| Name | Type | Description |
| worksheetHandle | CAObjHandle | A handle to an Excel Worksheet object. |
| cellRange | char [] | The range of an individual cell. This value should be a string containing the cell range, such as "A1". If the range contains multiple cells, this function will examine the uppper leftmost cell in the range. |
| Output | ||
| Name | Type | Description |
| length | int | The length of the string needed to hold the contents of the cell. The length does not include the terminating NUL byte. If the cell is empty this value will be 0. |
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