ListBox_SetTabStops macro (windowsx.h)

Article
10/23/2024

Sets the tab-stop positions in a list box. You can use this macro or send the LB_SETTABSTOPS message explicitly.

Syntax

BOOL ListBox_SetTabStops(
   HWND hwndCtl,
   int  cTabs,
   int  *lpTabs
);

Parameters

hwndCtl

Type: HWND

A handle to the control.

cTabs

Type: int

The number of elements in the lpTabs array.

lpTabs

Type: int*

A pointer to an array of integers containing the tab stops. The integers represent the number of quarters of the average character width for the font that is selected into the list box. For example, a tab stop of 4 is placed at 1.0 character units, and a tab stop of 6 is placed at 1.5 average character units. However, if the list box is part of a dialog box, the integers are in dialog template units. The tab stops must be sorted in ascending order; backward tabs are not allowed.

Return value

Type: BOOL

If all the specified tabs are set, the return value is TRUE; otherwise, it is FALSE.

Remarks

For more information, see LB_SETTABSTOPS.

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

Share via