sapgui_tree_select_node

Tree Functions

Selects an additional node.

int sapgui_tree_select_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_select_node emulates a user clicking on a node in a MultipleNodeSelection tree. A call to sapgui_tree_select_node adds node nodeKey to the collection of selected nodes.

For SingleNodeSelection trees see sapgui_tree_set_selected_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 shows the use of sapgui_tree_select_node.

sapgui_tree_select_node("DragDrop Text 2", 
    "usr/cntlCONTAINER/shellcont/shellcont/shell/shellcont[0]/shell", 
    "Child2", 
    BEGIN_OPTIONAL, 
        "AdditionalInfo=sapgui1017", 
    END_OPTIONAL);