Header_Layout macro (commctrl.h)

Article
10/23/2024

Retrieves the correct size and position of a header control within the parent window. You can use this macro or send the HDM_LAYOUT message explicitly.

Syntax

BOOL Header_Layout(
  [in]  HWND       hwndHD,
  [out] LPHDLAYOUT playout
);

Parameters

[in] hwndHD

Type: HWND

A handle to the header control.

[out] playout

Type: LPHDLAYOUT

A pointer to an HDLAYOUT structure. The prc member specifies the coordinates of a rectangle, and the pwpos member receives the size and position for the header control within the rectangle.

Return value

Type: BOOL

Returns TRUE if successful, or FALSE otherwise.

Remarks

The Header_Layout macro is defined as follows:

#define Header_Layout(hwndHD, playout) \

    (BOOL)SendMessage((hwndHD), HDM_LAYOUT, 0, \

    (LPARAM)(LPHDLAYOUT)(playout))

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

Share via