Share this page

# sapgui_tree_get_node_text

Tree Functions

Retrieves node text.

    int sapgui_tree_get_node_text( const char *description, const char *treeID, const char *nodeKey, const char *outParamName, [args,] LAST ) ;

description | User entered text to aid in understanding script
treeID | Object ID Strings
nodeKey | Object ID Strings
outParamName | Parameter to store output
args | Optional Arguments
LAST | A marker indicating the end of the argument list. Not required if Optional Arguments are used.

The sapgui_tree_get_node_text data retrieval function gets the node text into outParamName.

## 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_get_node_text to get the text into "NodeText".

Copy code

    sapgui_tree_get_node_text("Get Node Text",
        "usr/cntlTREE_CONTAINER/shellcont/shell", // Tree Id
        "Child1", //Node Key
        "NodeText", // Output Parameter
        LAST );
    lr_output_message("Node Text : %s",lr_eval_string("{NodeText}"));

    Example: Output:
    "{ActionName}.c({line#}): Node Text : Child1 Col. 1."

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: