Share this page
sapgui_tree_set_checkbox
| Example: sapgui_tree_set_checkbox | Tree Functions |
Selects or clears a checkbox.
int sapgui_tree_set_checkbox( const char *description, const char *treeID, const char *nodeKey, const char *itemName, const char *value, [args,] LAST );
| description | User entered text to aid in understanding script |
| treeID | Object ID Strings |
| nodeKey | Object ID Strings |
| itemName | Object ID Strings |
| value | TRUE ("1") or FALSE ("0") |
| 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_set_checkbox applies to check boxes in a tree control. It selects the box if value is "True" and clears the box if value is "False".
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.
