Share this page
sapgui_tree_get_item_text
| Tree Functions |
Retrieves text property of item.
int sapgui_tree_get_item_text( const char *description, const char *treeID, const char *nodeKey, const char *itemName, const char *outParamName, [args,] LAST ) ;
| description | User entered text to aid in understanding script |
| treeID | Object ID Strings |
| nodeKey | Object ID Strings |
| itemName | 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_item_text data retrieval function gets the text property from an item in a tree 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_item_text to get the text of a check box.
sapgui_tree_get_item_text("CheckBox Text", "usr/cntlTREE_CONTAINER/shellcont/shell", // Tree ID
"Child1", //Node ID
"Column3", // Item Name
"CheckBoxText", // Output Parameter
LAST );
Example: Output:
Notify The value of parameter "CheckBoxText" was set to "Child1 Col. 3".
