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.

Parameters

Input
Name Type Description
panelHandle integer Specifier for a particular panel that is currently in memory. You obtain this handle from LoadPanel, NewPanel, or DuplicatePanel.
controlID integer 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 NewCtrl or 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);

Example

GetTableCellValLength (panelHandle, controlID, MakePoint (2, 3), &length);

Output
Name Type Description
length int (passed by reference) The length, in bytes, of the cell value string.

Return Value

Name Type Description
status integer Return value indicating whether the function was successful. A negative number indicates that an error occurred.

Code Error Message String
xx Success