Edit

Share via

ListBox_GetCaretIndex macro (windowsx.h)

  • Article

Retrieves the index of the list box item that has the focus rectangle in a multiple-selection list box. The item may or may not be selected. You can use this macro or send the LB_GETCARETINDEX message explicitly.

Syntax

int ListBox_GetCaretIndex(
   HWND hwndCtl
);

Parameters

hwndCtl

Type: HWND

A handle to the control.

Return value

Type: int

The zero-based index of the focused item, or 0 if no item has the focus.

Remarks

The contents of the list box are scrolled till the item is fully visible.

For more information, see LB_GETCARETINDEX.

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