Share this page

# sapgui_tree_press_header

Tree Functions

Clicks on column header.

    int sapgui_tree_press_header( const char *description, const char *treeID, const char *headerName, [args,] LAST ) ;

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

sapgui_tree_press_header emulates a user clicking on the column header in a tree.

When recording sapgui_tree_set_hierarchy_header_width the user must click on the header to record the action. At that time both sapgui_tree_set_hierarchy_header_width and sapgui_tree_press_header are recorded.

## 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_header to emulate a user clicking on the column header.

Copy code

    sapgui_tree_press_header("HierarchyHeader",
        "usr/cntlTREE_CONTAINER/shellcont/shell",
        "HierarchyHeader",
        BEGIN_OPTIONAL,
            "AdditionalInfo=info1063",
        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: