sapgui_grid_get_cell_data

Grid Functions

Gets contents of grid cell.

int sapgui_grid_get_cell_data( const char *description, const char *gridID, const char *row, const char *column, const char *outParamName, [args,] LAST );
description User entered text to aid in understanding script
gridIDObject ID Strings
row Grid row number. The first data row is numbered zero (0). If there is a header row it is numbered (-1).
columnObject ID Strings
outParamName Parameter to store output
argsOptional Arguments
LAST A marker indicating the end of the argument list. Not required if Optional Arguments are used.

The sapgui_grid_get_cell_data data retrieval function gets the data from a grid cell into outParamName.

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_grid_get_cell_data to get the information from a cell.

// Put the Grid ID in a parameter to make
    this example easier to read */
lr_save_string
     ("usr/cntlBCALVC_TOOLBAR_D100_C1/shellcont/shell",
    "GridID");
// Select cell in first data row in column "CONNID"
// The cell contains the number "17"
sapgui_grid_select_cell("'Overview' (-1, Connection number)", 
    "{GridID}", "0", "CONNID", LAST );

sapgui_grid_get_current_cell_column("Get Column", 
        "{GridID}", "CurrentCellColumn", LAST );

sapgui_grid_get_current_cell_row("Current Row", 
        "{GridID}", "CurrentCellRow", LAST );
sapgui_grid_get_cell_data("CellData", 
        "{GridID}",                   // Grid Id
        "{CurrentCellRow}",      // Row Number
        "{CurrentCellColumn}", // Column ID
        "CurrentCellData",      // Output Parameter
        LAST );
// Output: "Current Cell Row: '0', Column: 'CONNID', Data: '17'"
lr_output_message
    ("Current Cell Row: '%s', Column: '%s', Data: '%s'",
        lr_eval_string("{CurrentCellRow}"),
        lr_eval_string("{CurrentCellColumn}"),
        lr_eval_string("{CurrentCellData}"));