LB_SELECTSTRING
A version of this page is also available for
4/8/2010
This message is sent by an application to search a list box for an item that begins with the characters in a specified string. If a matching item is found, the item is selected.
Syntax
LB_SELECTSTRING wParam = (WPARAM) indexStart;
lParam = (LPARAM)(LPCTSTR) lpszFind;
Parameters
- indexStart
Zero-based index of the item before the first item to be searched. When the search reaches the bottom of the list box, it continues from the top of the list box back to the item specified by the indexStart parameter. If indexStart is –1, the entire list box is searched from the beginning.
- lpszFind
Long pointer to the null-terminated string that contains the prefix to search for. The search is case independent, so this string can contain any combination of uppercase and lowercase letters.
Return Value
The index of the selected item indicates a successful search. LB_ERR indicates an unsuccessful search; the current selection is not changed.
Remarks
The list box is scrolled, if necessary, to bring the selected item into view.
Do not use this message with a list box that has the LBS_MULTIPLESEL style.
An item is selected only if its initial characters from the starting point match the characters in the string specified by the lpszFind parameter.
If you create the list box with an owner-drawn style but without the LBS_HASSTRINGS style, this message returns the index of the item whose long value (supplied as the lParam parameter of the LB_ADDSTRING or LB_INSERTSTRING message) matches the value supplied as the lParam parameter of LB_SELECTSTRING.
Requirements
| Header | winuser.h |
| Windows Embedded CE | Windows CE 1.0 and later |
| Windows Mobile | Windows Mobile Version 5.0 and later |
See Also
Reference
LB_ADDSTRING
LB_FINDSTRING
LB_INSERTSTRING
List Boxes Messages