Edit

Share via

ListBox_GetText macro (windowsx.h)

  • Article

Gets a string from a list box. You can use this macro or send the LB_GETTEXT message explicitly.

Syntax

int ListBox_GetText(
   HWND    hwndCtl,
   int     index,
   LPCTSTR lpszBuffer
);

Parameters

hwndCtl

Type: HWND

A handle to the control.

index

Type: int

The zero-based index of the item.

lpszBuffer

Type: LPCTSTR

A pointer to the buffer that will receive the string. The buffer must have sufficient space for the string and a terminating null character. Before allocating the buffer, you can call ListBox_GetTextLen to retrieve the length of the string.

Return value

Type: int

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

Remarks

For more information, see LB_GETTEXT.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header windowsx.h