TreeView_GetISearchString macro
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 use this macro or send the TVM_GETISEARCHSTRING message explicitly.
Syntax
BOOL TreeView_GetISearchString( HWND hwndTV, LPTSTR lpsz );
Parameters
- hwndTV
-
Type: HWND
Handle to the tree-view control.
- lpsz
-
Type: LPTSTR
Pointer to the buffer that receives the incremental search string.
Return value
Returns TRUE if the string is retrieved; FALSE otherwise.
Remarks
Security Warning: Using this macro incorrectly might compromise the security of your program. You must allocate a large enough buffer to hold the string. First call the macro passing NULL in lpsz. This returns the number of characters, excluding NULL, that are required. Then call the macro 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
|
Minimum supported client |
Windows Vista [desktop apps only] |
|---|---|
|
Minimum supported server |
Windows Server 2003 [desktop apps only] |
|
Header |
|