LBItemFromPt function (commctrl.h)

Retrieves the index of the item at the specified point in a list box.

Syntax

int LBItemFromPt(
  HWND  hLB,
  POINT pt,
  BOOL  bAutoScroll
);

Parameters

hLB

Type: HWND

A handle to the list box to check.

pt

Type: POINT

A POINT structure that contains the screen coordinates to check.

bAutoScroll

Type: BOOL

A scroll flag. If this parameter is TRUE and the point is directly above or below the list box, the function scrolls the list box by one line and returns -1. Otherwise, the function does not scroll the list box.

Return value

Type: int

Returns the item identifier if the point is over a list item, or -1 otherwise.

Remarks

The LBItemFromPt function only scrolls the list box if a minimum amount of time has passed since it last did so. Timing prevents the list box from scrolling too quickly if the function is called repeatedly in rapid succession—for example, when DL_DRAGGING notification codes or WM_MOUSEMOVE messages are processed.

If the specified point is outside the client area of the list box and bAutoScroll is TRUE, the function scrolls the list box instead of returning an item identifier.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	commctrl.h
Library	Comctl32.lib
DLL	Comctl32.dll