sapgui_tree_select_item

Tree Functions

Selects item in tree.

int sapgui_tree_select_item( const char *description, const char *treeID, const char *nodeKey, const char *itemName, [args,] LAST ) ;
description User entered text to aid in understanding script
treeIDObject ID Strings
nodeKeyObject ID Strings
itemNameObject ID Strings
argsOptional 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_select_item applies to any selectable item in a tree control. It emulates a user clicking on the item itemName to select it. If the item is not visible in the tree pane when sapgui_tree_select_item is called the tree is scrolled so that the item is visible.

Many functions that act on items in a tree require that sapgui_tree_select_item 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 uses sapgui_tree_select_item to select the title heading of a node.

sapgui_tree_select_item("Tree Controls, REPTITLE", 
    "shellcont/shell", 
    "000710", 
    "REPTITLE", 
    BEGIN_OPTIONAL, 
        "AdditionalInfo=info1016", 
    END_OPTIONAL);