TreeView_DeleteItem macro (commctrl.h)

Remove um item e todos os filhos de um controle de exibição de árvore. Você também pode enviar a mensagem TVM_DELETEITEM explicitamente.

Sintaxe

BOOL TreeView_DeleteItem(
   HWND      hwnd,
   HTREEITEM hitem
);

Parâmetros

hwnd

Tipo: HWND

Manipule para o controle de exibição de árvore.

hitem

Tipo: HTREEITEM

O HTREEITEM identificador para o item a ser excluído. Se hitem estiver definido como TVI_ROOT, todos os itens serão excluídos do controle de exibição de árvore. Você também pode usar a macro TreeView_DeleteAllItems para excluir todos os itens.

Valor de retorno

Tipo: BOOL

Retorna TRUE se tiver êxito ou false caso contrário.

Observações

Não é seguro excluir itens em resposta a uma notificação, como TVN_SELCHANGING.

Depois que um item é excluído, seu identificador é inválido e não pode ser usado.

A janela pai recebe um código de notificação TVN_DELETEITEM quando cada item é removido.

Se o rótulo do item estiver sendo editado, a operação de edição será cancelada e a janela pai receberá o código de notificação TVN_ENDLABELEDIT.

Se você excluir todos os itens em um controle de exibição de árvore que tenha o estilo TVS_NOSCROLL, os itens adicionados posteriormente poderão não ser exibidos corretamente. Para obter mais informações, consulte TreeView_DeleteAllItems.

Requisitos

Requisito	Valor
de cliente com suporte mínimo	Windows Vista [somente aplicativos da área de trabalho]
servidor com suporte mínimo	Windows Server 2003 [somente aplicativos da área de trabalho]
da Plataforma de Destino	Windows
cabeçalho	commctrl.h