SftTree/DLL 7.5 - Tree Control

SelItemsArray

Returns an array of SFTTREE_SELENTRY structures describing groups of selected items.

C

void WINAPI SftTree_GetSelItemsArray(HWND hwndCtl,
        int* lpCount,
        LPCSFTTREE_SELENTRY* lpArray);
void WINAPI SftTreeSplit_GetSelItemsArray(HWND hwndCtl,
        int* lpCount,
        LPCSFTTREE_SELENTRY* lpArray);

C++

void CSftTree::GetSelItemsArray(int* lpCount, LPCSFTTREE_SELENTRY* lpArray) const;
void CSftTreeSplit::GetSelItemsArray(int* lpCount, LPCSFTTREE_SELENTRY* lpArray) const;

Parameters

hwndCtl

The window handle of the tree control.

lpCount

A pointer to a field where the number of groups is returned. This is the number of SFTTREE_SELENTRY structures returned in lpArray. It is not the total number of selected items. GetSelCount can be used to retrieve the total number of selected items.

lpArray

Address of an area where a pointer to the SFTTREE_SELENTRY structures is returned.

Comments

The GetSelItemsArray function returns an array of SFTTREE_SELENTRY structures describing groups of selected items.

This function can be used for single and multiple selection tree controls. For a single selection tree control, GetCurSel can be used to retrieve the currently selected item.

In a multiple selection tree control, many non contiguous groups of items may be selected. While GetSelItems returns an index for each selected item, GetSelItemsArray returns an array of groups of selected items. For a large number of selected items this is the preferred method.

Note that the array becomes invalid as soon as a selection is changed using API functions or by the user. When using API calls to modify the selected items, the array has to be retrieved again using GetSelItemsArray.

The array returned by GetSelItemsArray is read/only and cannot be modified. SetCurSel, SetSel and SelItemRange should be used to select or deselect items.

See Also C/C++ API | Categories | Notifications