LB_GETTEXT

This message is sent by an application to retrieve a string from a list box.

At a Glance

Header file: Winuser.h
Windows CE versions: 1.0 and later

Syntax

LB_GETTEXT wParam = (WPARAM) index;
lParam = (LPARAM)(LPCTSTR) lpszBuffer;

Parameters

index

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

long pointer to the buffer to 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 length of the string, in characters and excluding the terminating null character, indicates success. LB_ERR indicates that index does not specify a valid index.

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).

See Also

LB_GETTEXTLEN