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

SetClassLongPtrW

関数
ウィンドウクラスの情報をポインタ幅で設定する(Unicode)。
DLLUSER32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// USER32.dll  (Unicode / -W)
#include <windows.h>

UINT_PTR SetClassLongPtrW(
    HWND hWnd,
    GET_CLASS_LONG_INDEX nIndex,
    INT_PTR dwNewLong
);

パラメーター

名前方向説明
hWndHWNDinウィンドウへのハンドル、および間接的にそのウィンドウが属するクラスへのハンドル。
nIndexGET_CLASS_LONG_INDEXin

置き換える値。追加のクラスメモリ内の値を設定するには、設定する値の正のゼロベースのバイトオフセットを指定します。有効な値は、ゼロから追加のクラスメモリのバイト数マイナス 8 までの範囲です。たとえば、24 バイト以上の追加のクラスメモリを指定した場合、値 16 は 3 番目の整数へのインデックスになります。WNDCLASSEX 構造体以外の値を設定するには、次のいずれかの値を指定します。

意味
GCL_CBCLSEXTRA
-20
クラスに関連付けられた追加メモリのサイズをバイト単位で設定します。この値を設定しても、既に割り当てられている追加バイト数は変更されません。
GCL_CBWNDEXTRA
-18
クラス内の各ウィンドウに関連付けられた追加ウィンドウメモリのサイズをバイト単位で設定します。この値を設定しても、既に割り当てられている追加バイト数は変更されません。このメモリへのアクセス方法については、SetWindowLongPtr を参照してください。
GCLP_ HBRBACKGROUND
-10
クラスに関連付けられた背景ブラシへのハンドルを置き換えます。
GCLP_HCURSOR
-12
クラスに関連付けられたカーソルへのハンドルを置き換えます。
GCLP_HICON
-14
クラスに関連付けられたアイコンへのハンドルを置き換えます。
GCLP_HICONSM
-34
クラスに関連付けられた小さいアイコンへのハンドルを取得します。
GCLP_HMODULE
-16
クラスを登録したモジュールへのハンドルを置き換えます。
GCLP_MENUNAME
-8
メニュー名文字列へのポインターを置き換えます。この文字列は、クラスに関連付けられたメニューリソースを識別します。
GCL_STYLE
-26
ウィンドウクラスのスタイルビットを置き換えます。
GCLP_WNDPROC
-24
クラスに関連付けられたウィンドウプロシージャへのポインターを置き換えます。
dwNewLongINT_PTRin置き換える値。

戻り値の型: UINT_PTR

公式ドキュメント

指定したウィンドウが属するクラスについて、追加のクラスメモリ内または WNDCLASSEX 構造体内の指定したオフセットにある値を置き換えます。(Unicode)

戻り値

型: ULONG_PTR

関数が成功した場合、戻り値は指定したオフセットの以前の値です。以前に設定されていなかった場合、戻り値はゼロです。

関数が失敗した場合、戻り値はゼロです。拡張エラー情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

SetClassLongPtr 関数と GCLP_WNDPROC インデックスを使用してウィンドウプロシージャを置き換える場合、そのウィンドウプロシージャは WindowProc コールバック関数の説明に記載されているガイドラインに従う必要があります。

GCLP_WNDPROC インデックスを指定して SetClassLongPtr を呼び出すと、そのクラスのサブクラスが作成され、以降にそのクラスで作成されるすべてのウィンドウに影響します。アプリケーションはシステムクラスをサブクラス化できますが、別のプロセスによって作成されたウィンドウクラスをサブクラス化すべきではありません。

追加のクラスメモリを予約するには、RegisterClassEx 関数で使用する WNDCLASSEX 構造体の cbClsExtra メンバーにゼロ以外の値を指定します。

SetClassLongPtr 関数は注意して使用してください。たとえば、SetClassLongPtr を使用してクラスの背景色を変更することは可能ですが、この変更によってクラスに属するすべてのウィンドウがただちに再描画されるわけではありません。

メモ

winuser.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして SetClassLongPtr を定義します。エンコーディング中立のエイリアスと、エンコーディング中立でないコードを混在させて使用すると、不一致が生じ、コンパイルエラーまたは実行時エラーを引き起こす可能性があります。詳細については、関数プロトタイプの規則を参照してください。

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

各言語での呼び出し定義

// USER32.dll  (Unicode / -W)
#include <windows.h>

UINT_PTR SetClassLongPtrW(
    HWND hWnd,
    GET_CLASS_LONG_INDEX nIndex,
    INT_PTR dwNewLong
);
[DllImport("USER32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern UIntPtr SetClassLongPtrW(
    IntPtr hWnd,   // HWND
    int nIndex,   // GET_CLASS_LONG_INDEX
    IntPtr dwNewLong   // INT_PTR
);
<DllImport("USER32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetClassLongPtrW(
    hWnd As IntPtr,   ' HWND
    nIndex As Integer,   ' GET_CLASS_LONG_INDEX
    dwNewLong As IntPtr   ' INT_PTR
) As UIntPtr
End Function
' hWnd : HWND
' nIndex : GET_CLASS_LONG_INDEX
' dwNewLong : INT_PTR
Declare PtrSafe Function SetClassLongPtrW Lib "user32" ( _
    ByVal hWnd As LongPtr, _
    ByVal nIndex As Long, _
    ByVal dwNewLong As LongPtr) As LongPtr
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SetClassLongPtrW = ctypes.windll.user32.SetClassLongPtrW
SetClassLongPtrW.restype = ctypes.c_size_t
SetClassLongPtrW.argtypes = [
    wintypes.HANDLE,  # hWnd : HWND
    ctypes.c_int,  # nIndex : GET_CLASS_LONG_INDEX
    ctypes.c_ssize_t,  # dwNewLong : INT_PTR
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
SetClassLongPtrW = Fiddle::Function.new(
  lib['SetClassLongPtrW'],
  [
    Fiddle::TYPE_VOIDP,  # hWnd : HWND
    Fiddle::TYPE_INT,  # nIndex : GET_CLASS_LONG_INDEX
    Fiddle::TYPE_INTPTR_T,  # dwNewLong : INT_PTR
  ],
  Fiddle::TYPE_UINTPTR_T)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "user32")]
extern "system" {
    fn SetClassLongPtrW(
        hWnd: *mut core::ffi::c_void,  // HWND
        nIndex: i32,  // GET_CLASS_LONG_INDEX
        dwNewLong: isize  // INT_PTR
    ) -> usize;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("USER32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern UIntPtr SetClassLongPtrW(IntPtr hWnd, int nIndex, IntPtr dwNewLong);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_SetClassLongPtrW' -Namespace Win32 -PassThru
# $api::SetClassLongPtrW(hWnd, nIndex, dwNewLong)
#uselib "USER32.dll"
#func global SetClassLongPtrW "SetClassLongPtrW" wptr, wptr, wptr
; SetClassLongPtrW hWnd, nIndex, dwNewLong   ; 戻り値は stat
; hWnd : HWND -> "wptr"
; nIndex : GET_CLASS_LONG_INDEX -> "wptr"
; dwNewLong : INT_PTR -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "USER32.dll"
#cfunc global SetClassLongPtrW "SetClassLongPtrW" sptr, int, sptr
; res = SetClassLongPtrW(hWnd, nIndex, dwNewLong)
; hWnd : HWND -> "sptr"
; nIndex : GET_CLASS_LONG_INDEX -> "int"
; dwNewLong : INT_PTR -> "sptr"
; UINT_PTR SetClassLongPtrW(HWND hWnd, GET_CLASS_LONG_INDEX nIndex, INT_PTR dwNewLong)
#uselib "USER32.dll"
#cfunc global SetClassLongPtrW "SetClassLongPtrW" intptr, int, intptr
; res = SetClassLongPtrW(hWnd, nIndex, dwNewLong)
; hWnd : HWND -> "intptr"
; nIndex : GET_CLASS_LONG_INDEX -> "int"
; dwNewLong : INT_PTR -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procSetClassLongPtrW = user32.NewProc("SetClassLongPtrW")
)

// hWnd (HWND), nIndex (GET_CLASS_LONG_INDEX), dwNewLong (INT_PTR)
r1, _, err := procSetClassLongPtrW.Call(
	uintptr(hWnd),
	uintptr(nIndex),
	uintptr(dwNewLong),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // UINT_PTR
function SetClassLongPtrW(
  hWnd: THandle;   // HWND
  nIndex: Integer;   // GET_CLASS_LONG_INDEX
  dwNewLong: NativeInt   // INT_PTR
): NativeUInt; stdcall;
  external 'USER32.dll' name 'SetClassLongPtrW';
result := DllCall("USER32\SetClassLongPtrW"
    , "Ptr", hWnd   ; HWND
    , "Int", nIndex   ; GET_CLASS_LONG_INDEX
    , "Ptr", dwNewLong   ; INT_PTR
    , "UPtr")   ; return: UINT_PTR
●SetClassLongPtrW(hWnd, nIndex, dwNewLong) = DLL("USER32.dll", "int SetClassLongPtrW(void*, int, int)")
# 呼び出し: SetClassLongPtrW(hWnd, nIndex, dwNewLong)
# hWnd : HWND -> "void*"
# nIndex : GET_CLASS_LONG_INDEX -> "int"
# dwNewLong : INT_PTR -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "user32" fn SetClassLongPtrW(
    hWnd: ?*anyopaque, // HWND
    nIndex: i32, // GET_CLASS_LONG_INDEX
    dwNewLong: isize // INT_PTR
) callconv(std.os.windows.WINAPI) usize;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc SetClassLongPtrW(
    hWnd: pointer,  # HWND
    nIndex: int32,  # GET_CLASS_LONG_INDEX
    dwNewLong: int  # INT_PTR
): uint {.importc: "SetClassLongPtrW", stdcall, dynlib: "USER32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "user32");
extern(Windows)
size_t SetClassLongPtrW(
    void* hWnd,   // HWND
    int nIndex,   // GET_CLASS_LONG_INDEX
    ptrdiff_t dwNewLong   // INT_PTR
);
ccall((:SetClassLongPtrW, "USER32.dll"), stdcall, Csize_t,
      (Ptr{Cvoid}, Int32, Int),
      hWnd, nIndex, dwNewLong)
# hWnd : HWND -> Ptr{Cvoid}
# nIndex : GET_CLASS_LONG_INDEX -> Int32
# dwNewLong : INT_PTR -> Int
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
uintptr_t SetClassLongPtrW(
    void* hWnd,
    int32_t nIndex,
    intptr_t dwNewLong);
]]
local user32 = ffi.load("user32")
-- user32.SetClassLongPtrW(hWnd, nIndex, dwNewLong)
-- hWnd : HWND
-- nIndex : GET_CLASS_LONG_INDEX
-- dwNewLong : INT_PTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('USER32.dll');
const SetClassLongPtrW = lib.func('__stdcall', 'SetClassLongPtrW', 'uintptr_t', ['void *', 'int32_t', 'intptr_t']);
// SetClassLongPtrW(hWnd, nIndex, dwNewLong)
// hWnd : HWND -> 'void *'
// nIndex : GET_CLASS_LONG_INDEX -> 'int32_t'
// dwNewLong : INT_PTR -> 'intptr_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("USER32.dll", {
  SetClassLongPtrW: { parameters: ["pointer", "i32", "isize"], result: "usize" },
});
// lib.symbols.SetClassLongPtrW(hWnd, nIndex, dwNewLong)
// hWnd : HWND -> "pointer"
// nIndex : GET_CLASS_LONG_INDEX -> "i32"
// dwNewLong : INT_PTR -> "isize"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
size_t SetClassLongPtrW(
    void* hWnd,
    int32_t nIndex,
    intptr_t dwNewLong);
C, "USER32.dll");
// $ffi->SetClassLongPtrW(hWnd, nIndex, dwNewLong);
// hWnd : HWND
// nIndex : GET_CLASS_LONG_INDEX
// dwNewLong : INT_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 User32 extends StdCallLibrary {
    User32 INSTANCE = Native.load("user32", User32.class, W32APIOptions.UNICODE_OPTIONS);
    long SetClassLongPtrW(
        Pointer hWnd,   // HWND
        int nIndex,   // GET_CLASS_LONG_INDEX
        long dwNewLong   // INT_PTR
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("user32")]
lib LibUSER32
  fun SetClassLongPtrW = SetClassLongPtrW(
    hWnd : Void*,   # HWND
    nIndex : Int32,   # GET_CLASS_LONG_INDEX
    dwNewLong : LibC::SSizeT   # INT_PTR
  ) : LibC::SizeT
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SetClassLongPtrWNative = UintPtr Function(Pointer<Void>, Int32, IntPtr);
typedef SetClassLongPtrWDart = int Function(Pointer<Void>, int, int);
final SetClassLongPtrW = DynamicLibrary.open('USER32.dll')
    .lookupFunction<SetClassLongPtrWNative, SetClassLongPtrWDart>('SetClassLongPtrW');
// hWnd : HWND -> Pointer<Void>
// nIndex : GET_CLASS_LONG_INDEX -> Int32
// dwNewLong : INT_PTR -> IntPtr
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetClassLongPtrW(
  hWnd: THandle;   // HWND
  nIndex: Integer;   // GET_CLASS_LONG_INDEX
  dwNewLong: NativeInt   // INT_PTR
): NativeUInt; stdcall;
  external 'USER32.dll' name 'SetClassLongPtrW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetClassLongPtrW"
  c_SetClassLongPtrW :: Ptr () -> Int32 -> CIntPtr -> IO CUIntPtr
-- hWnd : HWND -> Ptr ()
-- nIndex : GET_CLASS_LONG_INDEX -> Int32
-- dwNewLong : INT_PTR -> CIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let setclasslongptrw =
  foreign "SetClassLongPtrW"
    ((ptr void) @-> int32_t @-> intptr_t @-> returning size_t)
(* hWnd : HWND -> (ptr void) *)
(* nIndex : GET_CLASS_LONG_INDEX -> int32_t *)
(* dwNewLong : INT_PTR -> intptr_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)

(cffi:defcfun ("SetClassLongPtrW" set-class-long-ptr-w :convention :stdcall) :uint64
  (h-wnd :pointer)   ; HWND
  (n-index :int32)   ; GET_CLASS_LONG_INDEX
  (dw-new-long :int64))   ; INT_PTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetClassLongPtrW = Win32::API::More->new('USER32',
    'WPARAM SetClassLongPtrW(HANDLE hWnd, int nIndex, LPARAM dwNewLong)');
# my $ret = $SetClassLongPtrW->Call($hWnd, $nIndex, $dwNewLong);
# hWnd : HWND -> HANDLE
# nIndex : GET_CLASS_LONG_INDEX -> int
# dwNewLong : INT_PTR -> LPARAM
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
公式の関連項目
使用する型