Share this page

# sapgui_grid_select_cells

Grid Functions

Selects cells in a grid.

    int sapgui_grid_select_cells( const char *description, const char *gridID, const char *cell1 ,..., celln, [args,] LAST );

description | User entered text to aid in understanding script
gridID | Object ID Strings
cells (cell1 ,..., celln) | A list of one or more "Grid row number, Grid column identifier" pairs. The list must be terminated with either an optional arguments clause or with LAST. Grid row number. The first data row is numbered zero (0). If there is a header row it is numbered (-1). Grid column identifier. The column identifier string is inserted in the script during recording. This string is the field name defined in the SAP data dictionary. This identifier cannot be replaced with a column number
args | Optional Arguments
LAST | A marker indicating the end of the argument list. Not required if Optional Arguments are used.

The sapgui_grid_select_cells function selects cells in a grid. The cells list is terminated either with "LAST" or "BEGIN_OPTIONAL".

## 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

In the following example, the sapgui_grid_select_cells function selects cells in a grid.

    sapgui_grid_select_cells("Select cells",
        "usr/cntlBCALVC_TOOLBAR_D100_C1/shellcont/shell",
        "1 ,CONNID", "4,CITYFROM",
        BEGIN_OPTIONAL,
             "AdditionalInfo=sapgui1019",
        END_OPTIONAL);

    sapgui_grid_select_cells("Select cells",
        "usr/cntlBCALVC_TOOLBAR_D100_C1/shellcont/shell",
        "1 ,CONNID", "4,CITYFROM", 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: