LabWindows/CVI

ExcelRpt_GetChartAxisAttribute

HRESULT ExcelRpt_GetChartAxisAttribute (CAObjHandle chartHandle, enum ExREnum_ExAxisType axisType, enum ExREnum_ExAxisGroup axisGroup, int attributeID, void *attributeValue);

Purpose

Gets attributes of a chart axis.

Parameters

Input
Name Type Description
chartHandle CAObjHandle A handle to an Excel Chart object.
axisType enum ExREnum_ExAxisType Specify the axis type. It must be one of the following values:

ExRConst_Category = 1
ExRConst_SeriesAxis = 3
ExRConst_Value = 2
axisGroup enum ExREnum_ExAxisGroup Specify the axis group. It must be one of the following values:

ExRConst_Primary = 1
ExRConst_Secondary = 2
attributeID int The Excel chart axis attribute value to obtain.

In the function panel, when you click the control or press <Enter>, <Spacebar>, or <Ctrl-down arrow>, a dialog box appears containing a hierarchical list of the available attributes. Attributes whose values cannot be obtained are dimmed. Help text is shown for each attribute. To select an attribute, double-click it or select it and then press <Enter>.

If the attribute shown in this ring control has named constants as valid values, you can open a list of them by moving to the Attribute Value control and pressing <Enter>. The Attribute Values dialog box displays the values and value help for the constants.
Output
Name Type Description
attributeValue void * The value of the specified Excel chart axis attribute.

If the attribute shown in this control has named constants as valid values, you can open a list of them by pressing <Enter>. The Attribute Values dialog box displays the values and value help for the 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

Log in to get a better experience