LB_GETTEXT

An application sends an LB_GETTEXT message to retrieve a string from a list box.

LB_GETTEXT 
wParam = (WPARAM) index;                // item index 
lParam = (LPARAM) (LPCTSTR) lpszBuffer; // address of buffer 
 

Parameters

index

Value of wParam. Specifies the zero-based index of the string to retrieve.

Windows 95 and Windows 98: The wParam parameter is limited to 16-bit values. This means list boxes cannot contain more than 32,767 items. Although the number of items is restricted, the total size in bytes of the items in a list box is limited only by available memory.

lpszBuffer

Value of lParam. Pointer to the buffer that will receive the string. The buffer must have sufficient space for the string and a terminating null character. An LB_GETTEXTLEN message can be sent before the LB_GETTEXT message to retrieve the length, in characters, of the string.

Return Values

The return value is the length of the string, in characters, excluding the terminating null character. If index does not specify a valid index, the return value is LB_ERR.

Remarks

If you create the list box with an owner-drawn style but without the LBS_HASSTRINGS style, the buffer pointed to by the lpszBuffer parameter will receive the 32-bit value associated with the item (the item data).

QuickInfo

  Windows NT: Requires version 3.1 or later.
  Windows: Requires Windows 95 or later.
  Windows CE: Requires version 1.0 or later.
  Header: Declared in winuser.h.

See Also

List Boxes Overview, List Box Messages, LB_GETTEXTLEN