Defines the type of the virtual data source callback used by SftTree/DLL to retrieve information about one item as it is needed by the tree control.

typedef void (CALLBACK* LPFNSFTTREE_VGETITEM)(
        HWND hwnd,
        SFTTREE_DWORD_PTR userData,
        int totCols,
        LONG index,
        LPSFTTREE_ITEM * lplpItem);

Parameters

hwnd

The window handle of the tree control.

userData

An application-specific value, as supplied in the call to VirtualInitialize using the SFTTREE_VIRTUALDEF structure.

totCols

The total number of columns defined for the tree control.

index

The zero-based index of the item whose attributes are to be retrieved.

lplpItem

A pointer to a pointer to a SFTTREE_ITEM structure.  The callback must set this parameter to point to a properly filled SFTTREE_ITEM structure provided by the callback.

Comments

LPFNSFTTREE_VGETITEM defines the type of the virtual data source callback used by SftTree/DLL to retrieve information about one item as it is needed by the tree control.

The callback must return a properly filled SFTTREE_ITEM structure.

This callback is only used if a virtual data source has been defined using VirtualInitialize.  If items are added using AddString or InsertString, the callback is not used.

The SFTTREE_ITEM structure can return pointers to additional information.  Any memory addressed by pointers returned in the structure must be in static memory or allocated dynamically. All memory is managed by the called application and no memory is allocated or freed by SftTree/DLL.

SftTree/DLL will always call SFTTREE_VRELEASEITEM before calling SFTTREE_VGETITEM for a new item, so an application can free any storage that was dynamically allocated by the callback.

This callback cannot modify the contents of the tree control in any way.  Updating the total number of items is not possible while the callback is called.

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