ホーム › UI.Shell › GetWindowSubclass

GetWindowSubclass

関数

ウィンドウのサブクラス参照データを取得する。

DLLCOMCTL32.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

// COMCTL32.dll
#include <windows.h>

BOOL GetWindowSubclass(
    HWND hWnd,
    SUBCLASSPROC pfnSubclass,
    UINT_PTR uIdSubclass,
    UINT_PTR* pdwRefData   // optional
);

パラメーター

名前	型	方向	説明
hWnd	HWND	in	サブクラス化されるウィンドウのハンドルです。
pfnSubclass	SUBCLASSPROC	in	ウィンドウプロシージャへのポインターです。このポインターとサブクラス ID により、このサブクラスコールバックが一意に識別されます。
uIdSubclass	UINT_PTR	in	UINT_PTR のサブクラス ID です。この ID とコールバックポインターにより、このサブクラスコールバックが一意に識別されます。注意: 64 ビット版の Windows では、これは 64 ビット値になります。
pdwRefData	UINT_PTR*	outoptional	参照データを返す DWORD へのポインターです。注意: 64 ビット版の Windows では、ポインターは 64 ビット値になります。

戻り値の型: BOOL

公式ドキュメント

指定したウィンドウサブクラスコールバックの参照データを取得します。

戻り値

型: BOOL

戻り値	説明
TRUE	サブクラスコールバックが正常にインストールされました。
FALSE	サブクラスコールバックがインストールされませんでした。

解説(Remarks)

GetWindowSubclass を使用するには、マニフェストで Comctl32.dll バージョン 6 を指定します。マニフェストの詳細については、Enabling Visual Styles を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// COMCTL32.dll
#include <windows.h>

BOOL GetWindowSubclass(
    HWND hWnd,
    SUBCLASSPROC pfnSubclass,
    UINT_PTR uIdSubclass,
    UINT_PTR* pdwRefData   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("COMCTL32.dll", ExactSpelling = true)]
static extern bool GetWindowSubclass(
    IntPtr hWnd,   // HWND
    IntPtr pfnSubclass,   // SUBCLASSPROC
    UIntPtr uIdSubclass,   // UINT_PTR
    IntPtr pdwRefData   // UINT_PTR* optional, out
);

<DllImport("COMCTL32.dll", ExactSpelling:=True)>
Public Shared Function GetWindowSubclass(
    hWnd As IntPtr,   ' HWND
    pfnSubclass As IntPtr,   ' SUBCLASSPROC
    uIdSubclass As UIntPtr,   ' UINT_PTR
    pdwRefData As IntPtr   ' UINT_PTR* optional, out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hWnd : HWND
' pfnSubclass : SUBCLASSPROC
' uIdSubclass : UINT_PTR
' pdwRefData : UINT_PTR* optional, out
Declare PtrSafe Function GetWindowSubclass Lib "comctl32" ( _
    ByVal hWnd As LongPtr, _
    ByVal pfnSubclass As LongPtr, _
    ByVal uIdSubclass As LongPtr, _
    ByVal pdwRefData As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetWindowSubclass = ctypes.windll.comctl32.GetWindowSubclass
GetWindowSubclass.restype = wintypes.BOOL
GetWindowSubclass.argtypes = [
    wintypes.HANDLE,  # hWnd : HWND
    ctypes.c_void_p,  # pfnSubclass : SUBCLASSPROC
    ctypes.c_size_t,  # uIdSubclass : UINT_PTR
    ctypes.POINTER(ctypes.c_size_t),  # pdwRefData : UINT_PTR* optional, out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('COMCTL32.dll')
GetWindowSubclass = Fiddle::Function.new(
  lib['GetWindowSubclass'],
  [
    Fiddle::TYPE_VOIDP,  # hWnd : HWND
    Fiddle::TYPE_VOIDP,  # pfnSubclass : SUBCLASSPROC
    Fiddle::TYPE_UINTPTR_T,  # uIdSubclass : UINT_PTR
    Fiddle::TYPE_VOIDP,  # pdwRefData : UINT_PTR* optional, out
  ],
  Fiddle::TYPE_INT)

#[link(name = "comctl32")]
extern "system" {
    fn GetWindowSubclass(
        hWnd: *mut core::ffi::c_void,  // HWND
        pfnSubclass: *const core::ffi::c_void,  // SUBCLASSPROC
        uIdSubclass: usize,  // UINT_PTR
        pdwRefData: *mut usize  // UINT_PTR* optional, out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("COMCTL32.dll")]
public static extern bool GetWindowSubclass(IntPtr hWnd, IntPtr pfnSubclass, UIntPtr uIdSubclass, IntPtr pdwRefData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'COMCTL32_GetWindowSubclass' -Namespace Win32 -PassThru
# $api::GetWindowSubclass(hWnd, pfnSubclass, uIdSubclass, pdwRefData)

#uselib "COMCTL32.dll"
#func global GetWindowSubclass "GetWindowSubclass" sptr, sptr, sptr, sptr
; GetWindowSubclass hWnd, pfnSubclass, uIdSubclass, varptr(pdwRefData)   ; 戻り値は stat
; hWnd : HWND -> "sptr"
; pfnSubclass : SUBCLASSPROC -> "sptr"
; uIdSubclass : UINT_PTR -> "sptr"
; pdwRefData : UINT_PTR* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "COMCTL32.dll"
#cfunc global GetWindowSubclass "GetWindowSubclass" sptr, sptr, sptr, var
; res = GetWindowSubclass(hWnd, pfnSubclass, uIdSubclass, pdwRefData)
; hWnd : HWND -> "sptr"
; pfnSubclass : SUBCLASSPROC -> "sptr"
; uIdSubclass : UINT_PTR -> "sptr"
; pdwRefData : UINT_PTR* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "COMCTL32.dll"
#cfunc global GetWindowSubclass "GetWindowSubclass" sptr, sptr, sptr, sptr
; res = GetWindowSubclass(hWnd, pfnSubclass, uIdSubclass, varptr(pdwRefData))
; hWnd : HWND -> "sptr"
; pfnSubclass : SUBCLASSPROC -> "sptr"
; uIdSubclass : UINT_PTR -> "sptr"
; pdwRefData : UINT_PTR* optional, out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。