Share this page

# 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.

## Example

The following example uses sapgui_tree_set_checkbox to select and clear a checkbox.

    // Select the box

    sapgui_tree_set_checkbox("Child1 Col. 1, Column3, True",

        "usr/cntlTREE_CONTAINER/shellcont/shell", // treeID

        "Child1", // nodeKey

        "Column3", //itemName

        "True",    //value

        BEGIN_OPTIONAL,

            "AdditionalInfo=info10110",

        END_OPTIONAL);

    // Clear the box

    sapgui_tree_set_checkbox("Child1 Col. 1, Column3, False",

        "usr/cntlTREE_CONTAINER/shellcont/shell",

        "Child1",

        "Column3",

        "False",

        BEGIN_OPTIONAL,

            "AdditionalInfo=info10109",

        END_OPTIONAL);

Tips to improve your search results... VuGen Function Reference Version 26.1 Function Reference 26.1 All View Local Help Center View Online Help Center Version: