TreeView_GetNextItem macro

Retrieves the tree-view item that bears the specified relationship to a specified item. You can use this macro, use one of the TreeView_Get macros described below, or send the TVM_GETNEXTITEM message explicitly.

Syntax


HTREEITEM TreeView_GetNextItem(
   HWND      hwndTV,
   HTREEITEM hitem,
   UINT      flag
);

Parameters

hwndTV

Type: HWND

Handle to the tree-view control.

hitem

Type: HTREEITEM

Handle to an item.

flag

Type: UINT

Flag specifying the item to retrieve. This parameter can be one of the following values:

ValueMeaning
TVGN_CARET

Retrieves the currently selected item. You can use the TreeView_GetSelection macro to send this message.

TVGN_CHILD

Retrieves the first child item of the item specified by the hitem parameter. You can use the TreeView_GetChild macro to send this message.

TVGN_DROPHILITE

Retrieves the item that is the target of a drag-and-drop operation. You can use the TreeView_GetDropHilight macro to send this message.

TVGN_FIRSTVISIBLE

Retrieves the first visible item. You can use the TreeView_GetFirstVisible macro to send this message.

TVGN_NEXT

Retrieves the next sibling item. You can use the TreeView_GetNextSibling macro to send this message.

TVGN_NEXTSELECTED

Windows Vista and later. Retrieves the next selected item. You can use the TreeView_GetNextSelected macro to send this message.

TVGN_NEXTVISIBLE

Retrieves the next visible item that follows the specified item. The specified item must be visible. Use the TVM_GETITEMRECT message to determine whether an item is visible. You can use the TreeView_GetNextVisible macro to send this message.

TVGN_PARENT

Retrieves the parent of the specified item. You can use the TreeView_GetParent macro to send this message.

TVGN_PREVIOUS

Retrieves the previous sibling item. You can use the TreeView_GetPrevSibling macro to send this message.

TVGN_PREVIOUSVISIBLE

Retrieves the first visible item that precedes the specified item. The specified item must be visible. Use the TVM_GETITEMRECT message to determine whether an item is visible. You can use the TreeView_GetPrevVisible macro to send this message.

TVGN_ROOT

Retrieves the topmost or very first item of the tree-view control. You can use the TreeView_GetRoot macro to send this message.

 

Return value

Returns the handle to the item if successful. For most cases, the message returns a NULL value to indicate an error. See the Remarks section for details

Remarks

This macro will return NULL if the item being retrieved is the root node of the tree. For example, if you use this macro with the TVGN_PARENT flag on a first-level child of the tree view's root node, the macro will return NULL.

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Header

Commctrl.h

 

 

Show: