Win32 API 日本語リファレンス
ホームUI.Shell › SetWindowSubclass

SetWindowSubclass

関数
ウィンドウにサブクラスプロシージャを設定する。
DLLCOMCTL32.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

BOOL SetWindowSubclass(
    HWND hWnd,
    SUBCLASSPROC pfnSubclass,
    UINT_PTR uIdSubclass,
    UINT_PTR dwRefData
);

パラメーター

名前方向説明
hWndHWNDinサブクラス化するウィンドウのハンドル。
pfnSubclassSUBCLASSPROCinウィンドウプロシージャへのポインター。このポインターとサブクラス ID により、このサブクラス化コールバックが一意に識別されます。コールバック関数のプロトタイプについては、SUBCLASSPROC を参照してください。
uIdSubclassUINT_PTRinサブクラス ID。この ID とサブクラスプロシージャの組み合わせにより、サブクラスが一意に識別されます。サブクラスを削除するには、サブクラスプロシージャとこの値を RemoveWindowSubclass 関数に渡します。この値は、サブクラスプロシージャの uIdSubclass パラメーターに渡されます。
dwRefDataUINT_PTRin参照データへの DWORD_PTR。この値の意味は、呼び出し元のアプリケーションによって決まります。この値は、サブクラスプロシージャの dwRefData パラメーターに渡されます。ウィンドウハンドル、サブクラスプロシージャ、uIdSubclass の組み合わせごとに、異なる dwRefData が関連付けられます。

戻り値の型: BOOL

公式ドキュメント

ウィンドウのサブクラス化コールバックをインストールまたは更新します。

戻り値

型: BOOL

サブクラス化コールバックが正常にインストールされた場合は TRUE、それ以外の場合は FALSE

解説(Remarks)

サブクラス化コールバックは、コールバックのアドレスと呼び出し元が定義したサブクラス ID の組み合わせによって識別されます。コールバックアドレスと ID のペアがまだインストールされていない場合、この関数はサブクラスをインストールします。ペアがすでにインストールされている場合、この関数は参照データを更新するだけです。

各コールバックは、単一の DWORD_PTR の参照データを格納できます。この参照データは、メッセージをフィルタリングするためにコールバック関数が呼び出されたときに渡されます。コールバックに対する参照カウントは行われません。コールバックは SetWindowSubclass を繰り返し呼び出して、参照データ要素の値を変更できます。

警告 サブクラス化ヘルパー関数を使用して、スレッドをまたいでウィンドウをサブクラス化することはできません。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

BOOL SetWindowSubclass(
    HWND hWnd,
    SUBCLASSPROC pfnSubclass,
    UINT_PTR uIdSubclass,
    UINT_PTR dwRefData
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("COMCTL32.dll", ExactSpelling = true)]
static extern bool SetWindowSubclass(
    IntPtr hWnd,   // HWND
    IntPtr pfnSubclass,   // SUBCLASSPROC
    UIntPtr uIdSubclass,   // UINT_PTR
    UIntPtr dwRefData   // UINT_PTR
);
<DllImport("COMCTL32.dll", ExactSpelling:=True)>
Public Shared Function SetWindowSubclass(
    hWnd As IntPtr,   ' HWND
    pfnSubclass As IntPtr,   ' SUBCLASSPROC
    uIdSubclass As UIntPtr,   ' UINT_PTR
    dwRefData As UIntPtr   ' UINT_PTR
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hWnd : HWND
' pfnSubclass : SUBCLASSPROC
' uIdSubclass : UINT_PTR
' dwRefData : UINT_PTR
Declare PtrSafe Function SetWindowSubclass Lib "comctl32" ( _
    ByVal hWnd As LongPtr, _
    ByVal pfnSubclass As LongPtr, _
    ByVal uIdSubclass As LongPtr, _
    ByVal dwRefData As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SetWindowSubclass = ctypes.windll.comctl32.SetWindowSubclass
SetWindowSubclass.restype = wintypes.BOOL
SetWindowSubclass.argtypes = [
    wintypes.HANDLE,  # hWnd : HWND
    ctypes.c_void_p,  # pfnSubclass : SUBCLASSPROC
    ctypes.c_size_t,  # uIdSubclass : UINT_PTR
    ctypes.c_size_t,  # dwRefData : UINT_PTR
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('COMCTL32.dll')
SetWindowSubclass = Fiddle::Function.new(
  lib['SetWindowSubclass'],
  [
    Fiddle::TYPE_VOIDP,  # hWnd : HWND
    Fiddle::TYPE_VOIDP,  # pfnSubclass : SUBCLASSPROC
    Fiddle::TYPE_UINTPTR_T,  # uIdSubclass : UINT_PTR
    Fiddle::TYPE_UINTPTR_T,  # dwRefData : UINT_PTR
  ],
  Fiddle::TYPE_INT)
#[link(name = "comctl32")]
extern "system" {
    fn SetWindowSubclass(
        hWnd: *mut core::ffi::c_void,  // HWND
        pfnSubclass: *const core::ffi::c_void,  // SUBCLASSPROC
        uIdSubclass: usize,  // UINT_PTR
        dwRefData: usize  // UINT_PTR
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("COMCTL32.dll")]
public static extern bool SetWindowSubclass(IntPtr hWnd, IntPtr pfnSubclass, UIntPtr uIdSubclass, UIntPtr dwRefData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'COMCTL32_SetWindowSubclass' -Namespace Win32 -PassThru
# $api::SetWindowSubclass(hWnd, pfnSubclass, uIdSubclass, dwRefData)
#uselib "COMCTL32.dll"
#func global SetWindowSubclass "SetWindowSubclass" sptr, sptr, sptr, sptr
; SetWindowSubclass hWnd, pfnSubclass, uIdSubclass, dwRefData   ; 戻り値は stat
; hWnd : HWND -> "sptr"
; pfnSubclass : SUBCLASSPROC -> "sptr"
; uIdSubclass : UINT_PTR -> "sptr"
; dwRefData : UINT_PTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "COMCTL32.dll"
#cfunc global SetWindowSubclass "SetWindowSubclass" sptr, sptr, sptr, sptr
; res = SetWindowSubclass(hWnd, pfnSubclass, uIdSubclass, dwRefData)
; hWnd : HWND -> "sptr"
; pfnSubclass : SUBCLASSPROC -> "sptr"
; uIdSubclass : UINT_PTR -> "sptr"
; dwRefData : UINT_PTR -> "sptr"
; BOOL SetWindowSubclass(HWND hWnd, SUBCLASSPROC pfnSubclass, UINT_PTR uIdSubclass, UINT_PTR dwRefData)
#uselib "COMCTL32.dll"
#cfunc global SetWindowSubclass "SetWindowSubclass" intptr, intptr, intptr, intptr
; res = SetWindowSubclass(hWnd, pfnSubclass, uIdSubclass, dwRefData)
; hWnd : HWND -> "intptr"
; pfnSubclass : SUBCLASSPROC -> "intptr"
; uIdSubclass : UINT_PTR -> "intptr"
; dwRefData : UINT_PTR -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	comctl32 = windows.NewLazySystemDLL("COMCTL32.dll")
	procSetWindowSubclass = comctl32.NewProc("SetWindowSubclass")
)

// hWnd (HWND), pfnSubclass (SUBCLASSPROC), uIdSubclass (UINT_PTR), dwRefData (UINT_PTR)
r1, _, err := procSetWindowSubclass.Call(
	uintptr(hWnd),
	uintptr(pfnSubclass),
	uintptr(uIdSubclass),
	uintptr(dwRefData),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SetWindowSubclass(
  hWnd: THandle;   // HWND
  pfnSubclass: Pointer;   // SUBCLASSPROC
  uIdSubclass: NativeUInt;   // UINT_PTR
  dwRefData: NativeUInt   // UINT_PTR
): BOOL; stdcall;
  external 'COMCTL32.dll' name 'SetWindowSubclass';
result := DllCall("COMCTL32\SetWindowSubclass"
    , "Ptr", hWnd   ; HWND
    , "Ptr", pfnSubclass   ; SUBCLASSPROC
    , "UPtr", uIdSubclass   ; UINT_PTR
    , "UPtr", dwRefData   ; UINT_PTR
    , "Int")   ; return: BOOL
●SetWindowSubclass(hWnd, pfnSubclass, uIdSubclass, dwRefData) = DLL("COMCTL32.dll", "bool SetWindowSubclass(void*, void*, int, int)")
# 呼び出し: SetWindowSubclass(hWnd, pfnSubclass, uIdSubclass, dwRefData)
# hWnd : HWND -> "void*"
# pfnSubclass : SUBCLASSPROC -> "void*"
# uIdSubclass : UINT_PTR -> "int"
# dwRefData : UINT_PTR -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "comctl32" fn SetWindowSubclass(
    hWnd: ?*anyopaque, // HWND
    pfnSubclass: ?*anyopaque, // SUBCLASSPROC
    uIdSubclass: usize, // UINT_PTR
    dwRefData: usize // UINT_PTR
) callconv(std.os.windows.WINAPI) i32;
proc SetWindowSubclass(
    hWnd: pointer,  # HWND
    pfnSubclass: pointer,  # SUBCLASSPROC
    uIdSubclass: uint,  # UINT_PTR
    dwRefData: uint  # UINT_PTR
): int32 {.importc: "SetWindowSubclass", stdcall, dynlib: "COMCTL32.dll".}
pragma(lib, "comctl32");
extern(Windows)
int SetWindowSubclass(
    void* hWnd,   // HWND
    void* pfnSubclass,   // SUBCLASSPROC
    size_t uIdSubclass,   // UINT_PTR
    size_t dwRefData   // UINT_PTR
);
ccall((:SetWindowSubclass, "COMCTL32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Ptr{Cvoid}, Csize_t, Csize_t),
      hWnd, pfnSubclass, uIdSubclass, dwRefData)
# hWnd : HWND -> Ptr{Cvoid}
# pfnSubclass : SUBCLASSPROC -> Ptr{Cvoid}
# uIdSubclass : UINT_PTR -> Csize_t
# dwRefData : UINT_PTR -> Csize_t
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SetWindowSubclass(
    void* hWnd,
    void* pfnSubclass,
    uintptr_t uIdSubclass,
    uintptr_t dwRefData);
]]
local comctl32 = ffi.load("comctl32")
-- comctl32.SetWindowSubclass(hWnd, pfnSubclass, uIdSubclass, dwRefData)
-- hWnd : HWND
-- pfnSubclass : SUBCLASSPROC
-- uIdSubclass : UINT_PTR
-- dwRefData : UINT_PTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('COMCTL32.dll');
const SetWindowSubclass = lib.func('__stdcall', 'SetWindowSubclass', 'int32_t', ['void *', 'void *', 'uintptr_t', 'uintptr_t']);
// SetWindowSubclass(hWnd, pfnSubclass, uIdSubclass, dwRefData)
// hWnd : HWND -> 'void *'
// pfnSubclass : SUBCLASSPROC -> 'void *'
// uIdSubclass : UINT_PTR -> 'uintptr_t'
// dwRefData : UINT_PTR -> 'uintptr_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
// コールバック(関数ポインタ)は koffi.proto/koffi.register で型を定義して渡す(素の void* では JS 関数を渡せない)。
const lib = Deno.dlopen("COMCTL32.dll", {
  SetWindowSubclass: { parameters: ["pointer", "pointer", "usize", "usize"], result: "i32" },
});
// lib.symbols.SetWindowSubclass(hWnd, pfnSubclass, uIdSubclass, dwRefData)
// hWnd : HWND -> "pointer"
// pfnSubclass : SUBCLASSPROC -> "pointer"
// uIdSubclass : UINT_PTR -> "usize"
// dwRefData : UINT_PTR -> "usize"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SetWindowSubclass(
    void* hWnd,
    void* pfnSubclass,
    size_t uIdSubclass,
    size_t dwRefData);
C, "COMCTL32.dll");
// $ffi->SetWindowSubclass(hWnd, pfnSubclass, uIdSubclass, dwRefData);
// hWnd : HWND
// pfnSubclass : SUBCLASSPROC
// uIdSubclass : UINT_PTR
// dwRefData : UINT_PTR
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Comctl32 extends StdCallLibrary {
    Comctl32 INSTANCE = Native.load("comctl32", Comctl32.class);
    boolean SetWindowSubclass(
        Pointer hWnd,   // HWND
        Callback pfnSubclass,   // SUBCLASSPROC
        long uIdSubclass,   // UINT_PTR
        long dwRefData   // UINT_PTR
    );
}
@[Link("comctl32")]
lib LibCOMCTL32
  fun SetWindowSubclass = SetWindowSubclass(
    hWnd : Void*,   # HWND
    pfnSubclass : Void*,   # SUBCLASSPROC
    uIdSubclass : LibC::SizeT,   # UINT_PTR
    dwRefData : LibC::SizeT   # UINT_PTR
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SetWindowSubclassNative = Int32 Function(Pointer<Void>, Pointer<Void>, UintPtr, UintPtr);
typedef SetWindowSubclassDart = int Function(Pointer<Void>, Pointer<Void>, int, int);
final SetWindowSubclass = DynamicLibrary.open('COMCTL32.dll')
    .lookupFunction<SetWindowSubclassNative, SetWindowSubclassDart>('SetWindowSubclass');
// hWnd : HWND -> Pointer<Void>
// pfnSubclass : SUBCLASSPROC -> Pointer<Void>
// uIdSubclass : UINT_PTR -> UintPtr
// dwRefData : UINT_PTR -> UintPtr
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetWindowSubclass(
  hWnd: THandle;   // HWND
  pfnSubclass: Pointer;   // SUBCLASSPROC
  uIdSubclass: NativeUInt;   // UINT_PTR
  dwRefData: NativeUInt   // UINT_PTR
): BOOL; stdcall;
  external 'COMCTL32.dll' name 'SetWindowSubclass';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetWindowSubclass"
  c_SetWindowSubclass :: Ptr () -> Ptr () -> CUIntPtr -> CUIntPtr -> IO CInt
-- hWnd : HWND -> Ptr ()
-- pfnSubclass : SUBCLASSPROC -> Ptr ()
-- uIdSubclass : UINT_PTR -> CUIntPtr
-- dwRefData : UINT_PTR -> CUIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let setwindowsubclass =
  foreign "SetWindowSubclass"
    ((ptr void) @-> (ptr void) @-> size_t @-> size_t @-> returning int32_t)
(* hWnd : HWND -> (ptr void) *)
(* pfnSubclass : SUBCLASSPROC -> (ptr void) *)
(* uIdSubclass : UINT_PTR -> size_t *)
(* dwRefData : UINT_PTR -> size_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library comctl32 (t "COMCTL32.dll"))
(cffi:use-foreign-library comctl32)

(cffi:defcfun ("SetWindowSubclass" set-window-subclass :convention :stdcall) :int32
  (h-wnd :pointer)   ; HWND
  (pfn-subclass :pointer)   ; SUBCLASSPROC
  (u-id-subclass :uint64)   ; UINT_PTR
  (dw-ref-data :uint64))   ; UINT_PTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetWindowSubclass = Win32::API::More->new('COMCTL32',
    'BOOL SetWindowSubclass(HANDLE hWnd, LPVOID pfnSubclass, WPARAM uIdSubclass, WPARAM dwRefData)');
# my $ret = $SetWindowSubclass->Call($hWnd, $pfnSubclass, $uIdSubclass, $dwRefData);
# hWnd : HWND -> HANDLE
# pfnSubclass : SUBCLASSPROC -> LPVOID
# uIdSubclass : UINT_PTR -> WPARAM
# dwRefData : UINT_PTR -> WPARAM
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。

関連項目

公式の関連項目
使用する型