GetWindowSubclass function (commctrl.h)

Article
02/22/2024

Retrieves the reference data for the specified window subclass callback.

Syntax

BOOL GetWindowSubclass(
  [in]  HWND         hWnd,
  [in]  SUBCLASSPROC pfnSubclass,
  [in]  UINT_PTR     uIdSubclass,
  [out] DWORD_PTR    *pdwRefData
);

Parameters

[in] hWnd

Type: HWND

The handle of the window being subclassed.

[in] pfnSubclass

Type: SUBCLASSPROC

A pointer to a window procedure. This pointer and the subclass ID uniquely identify this subclass callback.

[in] uIdSubclass

Type: UINT_PTR

UINT_PTR subclass ID. This ID and the callback pointer uniquely identify this subclass callback. Note: On 64-bit versions of Windows this is a 64-bit value.

[out] pdwRefData

Type: DWORD_PTR*

A pointer to a DWORD which will return the reference data. Note: On 64-bit versions of Windows, pointers are 64-bit values.

Return value

Type: BOOL

Return code	Description
TRUE	The subclass callback was successfully installed.
FALSE	The subclass callback was not installed.

Remarks

To use GetWindowSubclass, specify Comctl32.dll version 6 in the manifest. For more information on manifests, see Enabling Visual Styles.

Requirements

Requirement	Value
Minimum supported client	Windows XP [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	commctrl.h
Library	Comctl32.lib
DLL	Comctl32.dll (version 6.0 or later)
API set	ext-ms-win-shell-comctl32-window-l1-1-0 (introduced in Windows 10, version 10.0.14393)