Admin Production ni-theme
Current Publication

ExcelRpt_GetRangeDataType

LabWindows/CVI

ExcelRpt_GetRangeDataType

HRESULT ExcelRpt_GetRangeDataType (CAObjHandle worksheetHandle, char cellRange[], enum ExREnum_ExDataType *dataType);

Purpose

Gets the data type that can hold the data of all cells in the cell range.

If all the cells in the cell range have the same data type, then that data type will be returned. If the cells contain a mix of numeric types (including currency and date), then Double will be returned. If the cells contain a mix of numeric and string types, then String will be returned. If any of the cells are empty, then Empty will be returned.

Parameters

Input
Name Type Description
worksheetHandle CAObjHandle A handle to an Excel Worksheet object.
cellRange char [] A rectangular range of cells.

This value should be a string containing the cell range, such as "A1" or "A1:D5".
Output
Name Type Description
dataType enum ExREnum_ExDataType The data type that can hold the data of all cells in the cell range.

If all the cells in the cell range have the same data type, then that data type will be returned. If the cells contain a mix of numeric types (including currency and date), then Double will be returned. If the cells contain a mix of numeric and string types, then String will be returned. If any of the cells are empty, then Empty will be returned.

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