SAP GUI Functions (SAPGUI) > Alphabetical List of Functions > sapgui_grid_scroll_to_row

sapgui_grid_scroll_to_row

Example: sapgui_grid_scroll_to_row Grid Functions

Scrolls to a row in the grid.

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

sapgui_grid_scroll_to_row scrolls to the specified row in the grid, making it visible. It does not select the row.

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.