Share this page

# sapgui_grid_set_checkbox

Grid Functions

Selects or clears a grid checkbox.

    int sapgui_grid_set_checkbox( const char *description, const char *gridID, const char *row, const char *column, const char *newValue, [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).
column | Column number. 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.
newValue | "True" or "False"
args | Optional Arguments
LAST | A marker indicating the end of the argument list. Not required if Optional Arguments are used.

The sapgui_grid_set_checkbox function selects or clears a grid checkbox.

## 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_set_checkbox to select and clear a checkbox.

Copy code

    sapgui_grid_set_checkbox("Select box",
        ""usr/cntlBCALVC_TOOLBAR_D100_C1/shellcont/shell",
        "0",
        "CONNID",
        "True",
        BEGIN_OPTIONAL,
            "AdditionalInfo=sapgui1019",
        END_OPTIONAL);
    sapgui_grid_set_checkbox("Clear box",
        ""usr/cntlBCALVC_TOOLBAR_D100_C1/shellcont/shell",
        "0",
        "CONNID",
        "False",
        BEGIN_OPTIONAL,
            "AdditionalInfo=sapgui1019",
        END_OPTIONAL);

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