ExcelRpt_RangeBorder
- Updated2023-02-21
- 2 minute(s) read
HRESULT ExcelRpt_RangeBorder (CAObjHandle worksheetHandle, char cellRange[], enum ExREnum_ExLineStyle lineStyle, long color, enum ExREnum_ExBorderWeight borderWeight, unsigned char edges);
Purpose
Sets the borders of a cell range.
Parameters
| Input | ||||||||||||||||||
| Name | Type | Description | ||||||||||||||||
| worksheetHandle | CAObjHandle | A handle to an Excel Worksheet object. | ||||||||||||||||
| cellRange | char [] | A range of cells. This value should be a string containing the cell range, such as "A1" or "A1:D5". | ||||||||||||||||
| lineStyle | enum ExREnum_ExLineStyle | The line style of the border. It must be one of the following values:
|
||||||||||||||||
| color | long | RGB value is a 4–byte integer with the hexadecimal format 0x00RRGGBB, with the respective red, green, and blue components. See the MakeColor function in the User Interface Library for more information. | ||||||||||||||||
| borderWeight | enum ExREnum_ExBorderWeight | The weight of the border line. It must be one of the following values:
|
||||||||||||||||
| edges | unsigned char | The edges to include in the border. You must select one or more of the following values:
To select multiple values, combine them with the bitwise OR operator as show below. ExRConst_EdgeTop | ExRConst_EdgeBottom | ExRConst_EdgeLeft | ExRConst_EdgeRight |
||||||||||||||||
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