GetTableCellValLength
int GetTableCellValLength (int panelHandle, int controlID, Point cell, int *length);
Purpose
Returns the length, in bytes, of the value for the specified table control cell.
This function is valid only for strings of cell type VAL_CELL_STRING, VAL_CELL_RING, VAL_CELL_COMBO_BOX, or VAL_CELL_BUTTON.
Supported Controls
You can use GetTableCellValLength with table controls.
Parameters
| Input | ||
| Name | Type | Description |
| panelHandle | int | Specifier for a particular panel that is currently in memory. You can obtain this handle from functions such as LoadPanel and NewPanel. |
| controlID | int | The defined constant, located in the .uir header file, that you assigned to the control in the User Interface Editor, or the ID returned by functions such as NewCtrl and DuplicateCtrl. |
| cell | Point | A Point structure specifying the cell from which you want to obtain the value
length. The Point structure is defined as follows: typedef struct { int x; int y; } Point; Pass the one-based column index of the cell in the x field of the structure, and the one-based row index of the cell in the y field of the structure. You can create a Point without having to declare a variable by using the following function: Point MakePoint (int x, int y); ExampleGetTableCellValLength (panelHandle, controlID, MakePoint (2, 3), &length); |
| Output | ||
| Name | Type | Description |
| length | int | The length, in bytes, of the cell value string. The length does not include the terminating NUL byte. |
Return Value
| Name | Type | Description |
| status | int | Return value indicating whether the function was successful. A negative number indicates that an error occurred. |
Additional Information
Library: User Interface Library
Include file: userint.h
LabWindows/CVI compatibility: LabWindows/CVI 5.5 and later