sapgui_tree_set_selected_node

Tree Functions

Selects a node in a tree.

int sapgui_tree_set_selected_node( const char *description, const char *treeID, const char *nodeKey, [args,] LAST );
description User entered text to aid in understanding script
treeIDObject ID Strings
nodeKeyObject 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_set_selected_node emulates a user clicking on a node in a SingleNodeSelection tree. A call to sapgui_tree_set_selected_node unselects the previously selected node and selects the node nodeKey.

For MultipleNodeSelection trees see sapgui_tree_select_node.

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_set_selected_node to select a node.

sapgui_tree_set_selected_node("(CtrlTree)", 
    "usr/cntlTREE_CONTAINER/shellcont/shell", 
    "New1", 
    BEGIN_OPTIONAL, 
        "AdditionalInfo=info1044", 
    END_OPTIONAL);