Share this page

# sapgui_tree_press_key

Tree Functions

Presses a keyboard key.

    int sapgui_tree_press_key( const char *description, const char *treeID, const char *key, [args,] LAST );

description | User entered text to aid in understanding script
treeID | Object ID Strings
key | A key number in quotes.
args | Optional Arguments
LAST | A marker indicating the end of the argument list. Not required if Optional Arguments are used.

sapgui_tree_press_key emulates a user pressing the keyboard while tree has focus.

## 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_tree_press_key to send a keyboard enter.

Copy code

    sapgui_tree_press_key("Enter",
        "shellcont/shell",
        "0",
         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: