LB_INSERTSTRING Message

Platforms

Windows 95: Supported.
Windows 98: Supported.
Windows NT: Requires Windows NT 3.1 or later.
Windows 2000: Supported.
Windows CE: Requires Windows CE 1.0 or later.

Description & Usage

Sending the LB_INSERTSTRING message to a list box inserts a string into it. The string is placed at the position specified in the parameters, regardless of whether the list box is sorted or not.

Return Value

If successful, the message returns the zero-based index of the newly added string's position in the list box. If there is insufficient space to store the new string, the message returns LB_ERRSTRING. If some other error occurs, the message returns LB_ERR.

Visual Basic-Specific Issues

None.

Parameters

wParam: The zero-based index of the position to insert the string in the list box. If this is -1, the string is added to the end of the list.
lParam: The string to add to the list box.

Constant Definitions

Const LB_INSERTSTRING = &H181
Const LB_ERR = -1
Const LB_ERRSPACE = -2

Example

When the user clicks button Command1, insert three strings into list box List1. One string is added to the beginning, one to the third position, and one to the end. To run this example, place a list box named List1 and a command button named Command1 on a form window.

' This code is licensed according to the terms and conditions listed here.

' Declarations and such needed for the example:
' (Copy them to the (declarations) section of a module.)
Public Declare Function SendMessage Lib "user32.dll" Alias "SendMessageA" (ByVal hWnd As Long, ByVal Msg _
	As Long, wParam As Any, lParam As Any) As Long
Public Const LB_INSERTSTRING = &H181

' *** Place the following code inside a form window. ***

Private Sub Command1_Click()
	Dim retval As Long  ' return value
	
	' Add a string to the beginning of the drop-down box.
	retval = SendMessage(List1.hWnd, LB_INSERTSTRING, ByVal CLng(0), ByVal "First Item")
	' Insert a string at the third position in the drop-down box.
	retval = SendMessage(List1.hWnd, LB_INSERTSTRING, ByVal CLng(2), ByVal "Third Item")
	' Add a string to the end of the drop-down box.
	retval = SendMessage(List1.hWnd, LB_INSERTSTRING, ByVal CLng(-1), ByVal "Last Item")
End Sub