This macro retrieves the incremental search string of a list-view control. You can use this macro or send the LVM_GETISEARCHSTRING message explicitly.
At a Glance
| Header file: | Commctrl.h |
| Windows CE versions: | 1.0 and later |
| Related message: | LVM_GETISEARCHSTRING |
Syntax
BOOL ListView_GetISearchString( HWND hwnd, LPSTR lpsz );
Parameters
hwnd
Handle to the list view control.
lpsz
Long pointer to a buffer that receives the incremental search string.
Return Values
Returns the number of characters in the incremental search string, or zero if the list view control is not in incremental search mode.
Remarks
The incremental search string is the character sequence that the user types while the list view has the input focus. Each time the user types a character, the system appends the character to the search string and then searches for a matching item. If the system finds a match, it selects the item and, if necessary, scrolls it into view.
A time-out period is associated with each character that the user types. If the time-out period elapses before the user types another character, the incremental search string is reset.