CTreeCtrl::GetNextItem

[アーティクル]
08/09/2011

パラメーター hItem との間に nCode で示された関係を持つツリービューアイテムを取得します。

HTREEITEM GetNextItem(
   HTREEITEM hItem,
   UINT nCode 
) const;

パラメーター

hItem
ツリーアイテムのハンドル。
nCode
hItem との関係を示すフラグ。このフラグには、次のいずれかの値を指定できます。
- TVGN_CARET 現在選択されているアイテムを取得します。
- TVGN_CHILD hItem パラメーターで指定されているアイテムの最初の子アイテムを取得します。
- TVGN_DROPHILITE ドラッグアンドドロップ操作のドロップ先のアイテムを取得します。
- TVGN_FIRSTVISIBLE 最初に表示されるアイテムを取得します。
- TVGN_LASTVISIBLE ツリーで最後に展開されたアイテムを取得します。取得するのは、ツリービューウィンドウで最後に表示したアイテムではありません。
- TVGN_NEXT 次の兄弟アイテムを取得します。
- TVGN_NEXTVISIBLE 指定されたアイテムに続く、次に表示されるアイテムを取得します。
- TVGN_PARENT 指定されたアイテムの親アイテムを取得します。
- TVGN_PREVIOUS 前の兄弟アイテムを取得します。
- TVGN_PREVIOUSVISIBLE 指定されたアイテムより前の、最初に表示されるアイテムを取得します。
- TVGN_ROOT 指定されたアイテムを一部として持つ、ルートアイテムの最初の子アイテムを取得します。

戻り値

正常終了した場合は次のアイテムのハンドルを返します。それ以外の場合は NULL を返します。

解説

取得されるアイテムがツリーのルートノードの場合、この関数は NULL を返します。たとえば、ツリービューのルートノードの第 1 レベルの子にある TVGN_PARENT フラグでこのメッセージを使用すると、メッセージから NULL が返されます。

使用例

GetNextItem をループで使用する例については、「CTreeCtrl::DeleteItem」を参照してください。

// find the currently selected item
HTREEITEM hCurSel = m_TreeCtrl.GetNextItem(TVI_ROOT, TVGN_CARET);

// report it to the user
if (hCurSel == NULL)
{
   AfxMessageBox(_T("There is no selected item"));
}
else
{
   CString str;
   str.Format(_T("The currently selected item is \"%s\""),
      (LPCTSTR)m_TreeCtrl.GetItemText(hCurSel));
   AfxMessageBox((LPCTSTR)str);
}