Share this page

# sapgui_grid_press_column_header

Grid Functions

Clicks on grid column header.

    int sapgui_grid_press_column_header( const char *description, const char *gridID, const char *column,  [args,] LAST );

description | User entered text to aid in understanding script
gridID | Object ID Strings
column | 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.

sapgui_grid_press_column_header emulates a user clicking on a column header in a grid control.

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

Copy code

    // Save Grid ID to make code more readable
    lr_save_string("usr/cntlBCALVC_TOOLBAR_D100_C1/shellcont/shell",
        "GridID");

    sapgui_grid_press_column_header("Press Column Header",
            "{GridID}",
            "CONNID", // Column ID
            LAST );

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: