Share this page

# sapgui_tree_unselect_all

Tree Functions

Cancels all selections in tree.

    int sapgui_tree_unselect_all( const char *description, const char *treeID, [args,] LAST) ;

description | User entered text to aid in understanding script
treeID | Tree identifier
args | Optional Arguments
LAST | A marker indicating the end of the argument list. Not required if Optional Arguments are used.

sapgui_tree_unselect_all unselects all selected items in a tree without selecting a different item.

## 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_unselect_all to remove the selection from an item selected with sapgui_tree_select_item.

Copy code

    // After this call, the item is highlighted
    sapgui_tree_select_item("Root Col. 1, Column3",
        "usr/cntlTREE_CONTAINER/shellcont/shell",
        "Root",
        "Column3",
        BEGIN_OPTIONAL,
            "AdditionalInfo=info10103",
        END_OPTIONAL);
    // After this call, no items are selected
    sapgui_tree_unselect_all("Unselect All",
        "usr/cntlTREE_CONTAINER/shellcont/shell",
        LAST );

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: