CB_SELECTSTRING

CB_SELECTSTRING

wParam = (WPARAM) indexStart; /* item before first selection */

lParam = (LPARAM) (LPCSTR) lpszSelect; /* address of prefix str */

An application sends a CB_SELECTSTRING message to search the list box of a combo box for an item that begins with the characters in a specified string. If a matching item is found, the item is selected and copied to the edit control.

Parameters

indexStart

Value of wParam. Specifies the 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.

lpszSelect

Value of lParam. Points to the null-terminated string that contains the prefix to search for. The search is not case-sensitive, so this string can contain any combination of uppercase and lowercase letters.

Return Value

The return value is the index of the selected item if the string was found. The return value is CB_ERR and the current selection is not changed if the search was unsuccessful.

Comments

A string is selected only if its initial characters (from the starting point) match the characters in the prefix string.

If the combo box was created with an owner-drawn style but without the CBS_HASSTRINGS style, the action taken by the CB_SELECTSTRING message depends on whether the CBS_SORT style is used. If the CBS_SORT style is used, WM_COMPAREITEM messages are sent to the owner of the combo box to determine which item matches the specified string. Otherwise, CB_SELECTSTRING attempts to match the doubleword value against the value of the lpszFind parameter.

The CB_SELECTSTRING message may be used as either a wide-character message (where text arguments must use Unicode) or an ANSI message (where text arguments must use characters from the Windows 3.x character set installed).

See Also

CB_FINDSTRING, CB_FINDSTRINGEXACT, CB_SETCURSEL, WM_COMPAREITEM