SetClassLongPtrA
関数シグネチャ
// USER32.dll (ANSI / -A)
#include <windows.h>
UINT_PTR SetClassLongPtrA(
HWND hWnd,
GET_CLASS_LONG_INDEX nIndex,
INT_PTR dwNewLong
);パラメーター
| 名前 | 型 | 方向 | 説明 | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| hWnd | HWND | in | ウィンドウへのハンドル、および間接的にそのウィンドウが属するクラスへのハンドルです。 | ||||||||||||||||||||||
| nIndex | GET_CLASS_LONG_INDEX | in | 置き換える値です。追加のクラスメモリ内の値を設定するには、設定する値の正のゼロベースのバイトオフセットを指定します。有効な値は、ゼロから、追加のクラスメモリのバイト数から 8 を引いた値までの範囲です。たとえば、24 バイト以上の追加のクラスメモリを指定した場合、値 16 は 3 番目の整数へのインデックスになります。WNDCLASSEX 構造体以外の値を設定するには、次のいずれかの値を指定します。
| ||||||||||||||||||||||
| dwNewLong | INT_PTR | in | 置き換える値です。 |
戻り値の型: UINT_PTR
公式ドキュメント
指定したウィンドウが属するクラスについて、追加のクラスメモリまたは WNDCLASSEX 構造体内の指定したオフセットにある値を置き換えます。(ANSI)
戻り値
型: ULONG_PTR
関数が成功した場合、戻り値は指定したオフセットの以前の値です。以前に設定されていなかった場合、戻り値はゼロです。
関数が失敗した場合、戻り値はゼロです。拡張エラー情報を取得するには、GetLastError を呼び出します。
解説(Remarks)
SetClassLongPtr 関数と GCLP_WNDPROC インデックスを使用してウィンドウプロシージャを置き換える場合、そのウィンドウプロシージャは WindowProc コールバック関数の説明で指定されているガイドラインに準拠する必要があります。
GCLP_WNDPROC インデックスを指定して SetClassLongPtr を呼び出すと、そのクラスのサブクラスが作成され、以降そのクラスで作成されるすべてのウィンドウに影響します。アプリケーションはシステムクラスをサブクラス化できますが、別のプロセスが作成したウィンドウクラスをサブクラス化してはいけません。
追加のクラスメモリを予約するには、RegisterClassEx 関数で使用する WNDCLASSEX 構造体の cbClsExtra メンバーにゼロ以外の値を指定します。
SetClassLongPtr 関数の使用には注意してください。たとえば、SetClassLongPtr を使用してクラスの背景色を変更することは可能ですが、この変更によってそのクラスに属するすべてのウィンドウがただちに再描画されるわけではありません。
winuser.h ヘッダーは、SetClassLongPtr を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義しています。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、不一致が生じてコンパイルエラーまたは実行時エラーを引き起こす可能性があります。詳細については、関数プロトタイプの規約を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// USER32.dll (ANSI / -A)
#include <windows.h>
UINT_PTR SetClassLongPtrA(
HWND hWnd,
GET_CLASS_LONG_INDEX nIndex,
INT_PTR dwNewLong
);[DllImport("USER32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern UIntPtr SetClassLongPtrA(
IntPtr hWnd, // HWND
int nIndex, // GET_CLASS_LONG_INDEX
IntPtr dwNewLong // INT_PTR
);<DllImport("USER32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetClassLongPtrA(
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 SetClassLongPtrA Lib "user32" ( _
ByVal hWnd As LongPtr, _
ByVal nIndex As Long, _
ByVal dwNewLong As LongPtr) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
SetClassLongPtrA = ctypes.windll.user32.SetClassLongPtrA
SetClassLongPtrA.restype = ctypes.c_size_t
SetClassLongPtrA.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')
SetClassLongPtrA = Fiddle::Function.new(
lib['SetClassLongPtrA'],
[
Fiddle::TYPE_VOIDP, # hWnd : HWND
Fiddle::TYPE_INT, # nIndex : GET_CLASS_LONG_INDEX
Fiddle::TYPE_INTPTR_T, # dwNewLong : INT_PTR
],
Fiddle::TYPE_UINTPTR_T)#[link(name = "user32")]
extern "system" {
fn SetClassLongPtrA(
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.Ansi, SetLastError = true)]
public static extern UIntPtr SetClassLongPtrA(IntPtr hWnd, int nIndex, IntPtr dwNewLong);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_SetClassLongPtrA' -Namespace Win32 -PassThru
# $api::SetClassLongPtrA(hWnd, nIndex, dwNewLong)#uselib "USER32.dll"
#func global SetClassLongPtrA "SetClassLongPtrA" sptr, sptr, sptr
; SetClassLongPtrA hWnd, nIndex, dwNewLong ; 戻り値は stat
; hWnd : HWND -> "sptr"
; nIndex : GET_CLASS_LONG_INDEX -> "sptr"
; dwNewLong : INT_PTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "USER32.dll"
#cfunc global SetClassLongPtrA "SetClassLongPtrA" sptr, int, sptr
; res = SetClassLongPtrA(hWnd, nIndex, dwNewLong)
; hWnd : HWND -> "sptr"
; nIndex : GET_CLASS_LONG_INDEX -> "int"
; dwNewLong : INT_PTR -> "sptr"; UINT_PTR SetClassLongPtrA(HWND hWnd, GET_CLASS_LONG_INDEX nIndex, INT_PTR dwNewLong)
#uselib "USER32.dll"
#cfunc global SetClassLongPtrA "SetClassLongPtrA" intptr, int, intptr
; res = SetClassLongPtrA(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")
procSetClassLongPtrA = user32.NewProc("SetClassLongPtrA")
)
// hWnd (HWND), nIndex (GET_CLASS_LONG_INDEX), dwNewLong (INT_PTR)
r1, _, err := procSetClassLongPtrA.Call(
uintptr(hWnd),
uintptr(nIndex),
uintptr(dwNewLong),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // UINT_PTRfunction SetClassLongPtrA(
hWnd: THandle; // HWND
nIndex: Integer; // GET_CLASS_LONG_INDEX
dwNewLong: NativeInt // INT_PTR
): NativeUInt; stdcall;
external 'USER32.dll' name 'SetClassLongPtrA';result := DllCall("USER32\SetClassLongPtrA"
, "Ptr", hWnd ; HWND
, "Int", nIndex ; GET_CLASS_LONG_INDEX
, "Ptr", dwNewLong ; INT_PTR
, "UPtr") ; return: UINT_PTR●SetClassLongPtrA(hWnd, nIndex, dwNewLong) = DLL("USER32.dll", "int SetClassLongPtrA(void*, int, int)")
# 呼び出し: SetClassLongPtrA(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)。const std = @import("std");
extern "user32" fn SetClassLongPtrA(
hWnd: ?*anyopaque, // HWND
nIndex: i32, // GET_CLASS_LONG_INDEX
dwNewLong: isize // INT_PTR
) callconv(std.os.windows.WINAPI) usize;proc SetClassLongPtrA(
hWnd: pointer, # HWND
nIndex: int32, # GET_CLASS_LONG_INDEX
dwNewLong: int # INT_PTR
): uint {.importc: "SetClassLongPtrA", stdcall, dynlib: "USER32.dll".}pragma(lib, "user32");
extern(Windows)
size_t SetClassLongPtrA(
void* hWnd, // HWND
int nIndex, // GET_CLASS_LONG_INDEX
ptrdiff_t dwNewLong // INT_PTR
);ccall((:SetClassLongPtrA, "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 では無視)。local ffi = require("ffi")
ffi.cdef[[
uintptr_t SetClassLongPtrA(
void* hWnd,
int32_t nIndex,
intptr_t dwNewLong);
]]
local user32 = ffi.load("user32")
-- user32.SetClassLongPtrA(hWnd, nIndex, dwNewLong)
-- hWnd : HWND
-- nIndex : GET_CLASS_LONG_INDEX
-- dwNewLong : INT_PTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('USER32.dll');
const SetClassLongPtrA = lib.func('__stdcall', 'SetClassLongPtrA', 'uintptr_t', ['void *', 'int32_t', 'intptr_t']);
// SetClassLongPtrA(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", {
SetClassLongPtrA: { parameters: ["pointer", "i32", "isize"], result: "usize" },
});
// lib.symbols.SetClassLongPtrA(hWnd, nIndex, dwNewLong)
// hWnd : HWND -> "pointer"
// nIndex : GET_CLASS_LONG_INDEX -> "i32"
// dwNewLong : INT_PTR -> "isize"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
size_t SetClassLongPtrA(
void* hWnd,
int32_t nIndex,
intptr_t dwNewLong);
C, "USER32.dll");
// $ffi->SetClassLongPtrA(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.ASCII_OPTIONS);
long SetClassLongPtrA(
Pointer hWnd, // HWND
int nIndex, // GET_CLASS_LONG_INDEX
long dwNewLong // INT_PTR
);
}@[Link("user32")]
lib LibUSER32
fun SetClassLongPtrA = SetClassLongPtrA(
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 SetClassLongPtrANative = UintPtr Function(Pointer<Void>, Int32, IntPtr);
typedef SetClassLongPtrADart = int Function(Pointer<Void>, int, int);
final SetClassLongPtrA = DynamicLibrary.open('USER32.dll')
.lookupFunction<SetClassLongPtrANative, SetClassLongPtrADart>('SetClassLongPtrA');
// hWnd : HWND -> Pointer<Void>
// nIndex : GET_CLASS_LONG_INDEX -> Int32
// dwNewLong : INT_PTR -> IntPtr
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function SetClassLongPtrA(
hWnd: THandle; // HWND
nIndex: Integer; // GET_CLASS_LONG_INDEX
dwNewLong: NativeInt // INT_PTR
): NativeUInt; stdcall;
external 'USER32.dll' name 'SetClassLongPtrA';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "SetClassLongPtrA"
c_SetClassLongPtrA :: 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 setclasslongptra =
foreign "SetClassLongPtrA"
((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 ("SetClassLongPtrA" set-class-long-ptr-a :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 $SetClassLongPtrA = Win32::API::More->new('USER32',
'WPARAM SetClassLongPtrA(HANDLE hWnd, int nIndex, LPARAM dwNewLong)');
# my $ret = $SetClassLongPtrA->Call($hWnd, $nIndex, $dwNewLong);
# hWnd : HWND -> HANDLE
# nIndex : GET_CLASS_LONG_INDEX -> int
# dwNewLong : INT_PTR -> LPARAM
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f SetClassLongPtrW (Unicode版) — ウィンドウクラスの情報をポインタ幅で設定する(Unicode)。
- f GetClassLongPtrA — ウィンドウクラスの情報をポインタ幅で取得する(ANSI)。
- f RegisterClassExA — 拡張属性付きでウィンドウクラスを登録する(ANSI)。
- f SetWindowLongPtrA — ウィンドウの指定情報をポインタ幅で設定する(ANSI)。
- s WNDCLASSEXA
- c WNDPROC