TVM_GETISEARCHSTRING message

Retrieves the incremental search string for a tree-view control. The tree-view control uses the incremental search string to select an item based on characters typed by the user. You can send this message explicitly or by using the TreeView_GetISearchString macro.

Parameters

wParam

Must be zero.

lParam

Pointer to the buffer that receives the incremental search string.

Return value

Returns the number of characters in the incremental search string.

Remarks

Security Warning: Using this message incorrectly might compromise the security of your program. You must allocate a large enough buffer to hold the string. First call the message passing NULL in lParam. This returns the number of characters, excluding NULL, that are required. Then call the message a second time to retrieve the string. You should review Security Considerations: Microsoft Windows Controls before continuing.

If the tree-view control is not in incremental search mode, the return value is zero.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Header	Commctrl.h
Unicode and ANSI names	TVM_GETISEARCHSTRINGW (Unicode) and TVM_GETISEARCHSTRINGA (ANSI)