sapgui_grid_press_F1

Grid Functions

Emulates a user striking the F1 key.

int sapgui_grid_press_F1( const char *description, const char *gridID, [args,] LAST );
description User entered text to aid in understanding script
gridIDObject ID Strings
argsOptional Arguments
LAST A marker indicating the end of the argument list. Not required if Optional Arguments are used.

sapgui_grid_press_F1 emulates a user pressing the F1 key while the grid is active. The effect is to bring up the context sensitive help.

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_F1 to bring up the help.

sapgui_grid_press_F1("Any text",
    // Grid ID
	"usr/subSUB0:SAPLMEGUI:0013/subSUB2:SAPLMEVIEWS:1100/subSUB2:SAPLMEVIEWS:1200/subSUB1:SAPLMEGUI:3212/cntlGRIDCONTROL/shellcont/shell", 
    BEGIN_OPTIONAL", 
        "AdditionalInfo=info1075", 
    "END_OPTIONAL");>