Returns the zero-based index of the item to be expanded as a result of a call to StartAutoExpandTimer or SetAutoExpand.

C

int WINAPI SftTree_GetAutoExpandItem(HWND hwndCtl);
int WINAPI SftTreeSplit_GetAutoExpandItem(HWND hwndCtl);

C++

int CSftTree::GetAutoExpandItem() const;
int CSftTreeSplit::GetAutoExpandItem() const;

Parameters

hwndCtl

The window handle of the tree control.

Returns

GetAutoExpandItem returns the zero-based index of the item to be expanded as a result of a call to StartAutoExpandTimer or SetAutoExpand.

Comments

The GetAutoExpandItem function returns the zero-based index of the item to be expanded as a result of a call to StartAutoExpandTimer or SetAutoExpand.

The index returned by GetAutoExpandItem is valid immediately after a call to StartAutoExpandTimer or while the mouse hovers over a collapsed parent item, even before the item needs to be expanded using a SFTTREEN_AUTOEXPANDING notification.  Once the SFTTREEN_AUTOEXPANDING notification occurs, GetExpandCollapseIndex is used to retrieve the index value.

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