Returns the application defined value last used in the SFTTREE_VIRTUALDEF structure when VirtualInitialize was called.

C

SFTTREE_DWORD_PTR WINAPI SftTree_GetVirtualUserData(HWND hwndCtl);
SFTTREE_DWORD_PTR WINAPI SftTreeSplit_GetVirtualUserData(HWND hwndCtl);

C++

SFTTREE_DWORD_PTR CSftTree::GetVirtualUserData() const;
SFTTREE_DWORD_PTR CSftTreeSplit::GetVirtualUserData() const;

Parameters

hwndCtl

The window handle of the tree control.

Returns

Returns the application defined value last used in the SFTTREE_VIRTUALDEF structure when VirtualInitialize was called. NULL is returned if virtual mode has not been initialized.

Comments

The GetVirtualUserData function returns the application defined value last used in the SFTTREE_VIRTUALDEF structure when VirtualInitialize was called.

GetVirtualUserData provides the mechanism to retrieve the application defined value last used in the SFTTREE_VIRTUALDEF structure when VirtualInitialize was called.  This is usually used when only the tree control window handle or window object is known, and the application needs the value so it can access additional application specific information.

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