TreeView_GetItem macro (commctrl.h)

Retrieves some or all of a tree-view item's attributes. You can use this macro or send the TVM_GETITEM message explicitly.

Syntax

BOOL TreeView_GetItem(
   HWND     hwnd,
   LPTVITEM pitem
);

Parameters

hwnd

Type: HWND

Handle to the tree-view control.

pitem

Type: LPTVITEM

Pointer to a TVITEM structure that specifies the information to retrieve and receives information about the item. With version 4.71 and later, you can use a TVITEMEX structure instead.

Return value

Type: BOOL

Returns TRUE if successful, or FALSE otherwise.

Remarks

When the TVM_GETITEM message is sent, the hItem member of the TVITEM or TVITEMEX structure identifies the item to retrieve information about, and the mask member specifies the attributes to retrieve.

If the TVIF_TEXT flag is set in the mask member of the TVITEM or TVITEMEX structure, the pszText member must point to a valid buffer and the cchTextMax member must be set to the number of characters in that buffer. The returned text will not necessarily be stored in the original buffer passed by the application. It is possible that pszText will point to text in a new buffer rather than place it in the old buffer.

Requirements