SAP GUI Functions (SAPGUI) > Alphabetical List of Functions > sapgui_tree_collapse_node

sapgui_tree_collapse_node

Example: sapgui_tree_collapse_node Tree Functions

Hides children of a node.

int sapgui_tree_collapse_node( const char *description, const char *treeID, const char *nodeKey, [args,] LAST ) ;
description User entered text to aid in understanding script
treeID Object ID Strings
nodeKey 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_collapse_node emulates a user clicking on the "-" symbol to condense a node. After calling sapgui_tree_collapse_node the "-" symbol is replaced by a "+" symbol and the children of the node are not visible.

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.