TreeView_GetISearchString macro (commctrl.h)

Artigo
10/24/2024

Recupera a cadeia de caracteres de pesquisa incremental para um controle de exibição de árvore. O controle de exibição de árvore usa a cadeia de caracteres de pesquisa incremental para selecionar um item com base em caracteres digitado pelo usuário. Você pode usar essa macro ou enviar a mensagem TVM_GETISEARCHSTRING explicitamente.

Sintaxe

BOOL TreeView_GetISearchString(
   HWND   hwndTV,
   LPTSTR lpsz
);

Parâmetros

hwndTV

Tipo: HWND

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

lpsz

Tipo: LPTSTR

Ponteiro para o buffer que recebe a cadeia de caracteres de pesquisa incremental.

Valor de retorno

Tipo: BOOL

Retorna VERDADEIRO se a cadeia de caracteres for recuperada; false caso contrário.

Observações

Aviso de Segurança: Usar essa macro incorretamente pode comprometer a segurança do programa. Você deve alocar um buffer grande o suficiente para manter a cadeia de caracteres. Primeiro chame a macro passando NULL em lpsz. Isso retorna o número de caracteres, excluindo NULL, que são necessários. Em seguida, chame a macro uma segunda vez para recuperar a cadeia de caracteres. Você deve examinar considerações de segurança: Controles do Microsoft Windows antes de continuar.

Se o controle de exibição de árvore não estiver no modo de pesquisa incremental, o valor retornado será zero.

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

Compartilhar via