Share this page

# sapgui_table_get_text

Table Functions

Reads the text in a table cell.

    int sapgui_table_get_text( const char *description, const char *tableID, const char *row, const char *column, const char *paramName, [args,] LAST );

description | User entered text to aid in understanding script
tableID | Object ID Strings
row | Row number. The first data row is numbered zero (0). If there is a header row it is numbered (-1).
column | Column number. The first column is numbered zero (0).
paramName | Output parameter for the retrieved text
args | Optional Arguments
LAST | A marker indicating the end of the argument list. Not required if Optional Arguments are used.

The sapgui_table_get_text data retrieval function gets the text in the cell at row and column into the parameter paramName.

## Return Values

This function returns LR_PASS (0) on success or LR_FAIL (1) on failure.

## Parameterization

You can parameterize all string (char type) arguments.

## Example

The following example uses sapgui_table_get_text to confirm successful entry of a text in a cell.

    sapgui_table_get_text("Get the city before change",

        "usr/tblRSDEMO_TABLE_CONTROLTABLE_CONTROL",

        "15",

        "2",

        "PreviousCity",

        LAST );

    sapgui_table_set_text("(15, 'Depart.city')",

        "usr/tblRSDEMO_TABLE_CONTROLTABLE_CONTROL",

        "15",

        "2",

        "Philadelphia", LAST );

    sapgui_table_get_text("Confirm change, should be 'Philadelphia'",

        "usr/tblRSDEMO_TABLE_CONTROLTABLE_CONTROL",

        "15",

        "2",

        "NewCity",

        LAST );

Tips to improve your search results... VuGen Function Reference Version 26.1 Function Reference 26.1 All View Local Help Center View Online Help Center Version: