Share this page

# sapgui_tree_scroll_to_item

Tree Functions

Scrolls to item in tree.

    int sapgui_tree_scroll_to_item( const char *description, const char *treeID, const char *nodeKey, const char *itemName, [args,] LAST ) ;

description | User entered text to aid in understanding script
treeID | Object ID Strings
nodeKey | Object ID Strings
itemName | Object ID Strings
args | Optional Arguments, often including Dynamic Tree Node Keys.
LAST | A marker indicating the end of the argument list. Not required if Optional Arguments are used.

sapgui_tree_scroll_to_item is automatically recorded as a pair with sapgui_tree_select_item. It emulates using the scroll bar so that itemName is visible.

Note that for many functions that act on the item, sapgui_tree_select_item must be called first.

## 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 shows how sapgui_tree_scroll_to_item is recorded.

Copy code

    sapgui_tree_select_item("FULL API, REPTITLE",
    "shellcont/shell",
    "000687",
    "REPTITLE",
    BEGIN_OPTIONAL,
    "AdditionalInfo=info1028",
    END_OPTIONAL);
    sapgui_tree_scroll_to_item("FULL API, REPTITLE",
    "shellcont/shell",
    "000687",
    "REPTITLE",
    BEGIN_OPTIONAL,
    "AdditionalInfo=info1028",
    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: