SetWindowLongPtrA
関数シグネチャ
// USER32.dll (ANSI / -A)
#include <windows.h>
INT_PTR SetWindowLongPtrA(
HWND hWnd,
WINDOW_LONG_PTR_INDEX nIndex,
INT_PTR dwNewLong
);パラメーター
| 名前 | 型 | 方向 | 説明 | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| hWnd | HWND | in | ウィンドウへのハンドル。間接的に、そのウィンドウが属するクラスを指定します。hWnd パラメーターで指定されたウィンドウを所有するプロセスが、UIPI 階層において呼び出し元スレッドが存在するプロセスよりも高いプロセス特権を持つ場合、SetWindowLongPtr 関数は失敗します。 Windows XP/2000: hWnd パラメーターで指定されたウィンドウが呼び出し元スレッドと同じプロセスに属していない場合、SetWindowLongPtr 関数は失敗します。 | ||||||||||||||||||||||||
| nIndex | WINDOW_LONG_PTR_INDEX | in | 設定する値へのゼロ起点のオフセット。有効な値は、ゼロから追加ウィンドウメモリのバイト数より LONG_PTR のサイズを引いた値までの範囲です。それ以外の値を設定するには、次のいずれかの値を指定します。
次の値は、hWnd パラメーターがダイアログボックスを指定している場合にも使用できます。
| ||||||||||||||||||||||||
| dwNewLong | INT_PTR | in | 置き換える値。 |
戻り値の型: INT_PTR
公式ドキュメント
指定したウィンドウの属性を変更します。(ANSI)
戻り値
型: LONG_PTR
関数が成功した場合、戻り値は指定したオフセットの以前の値です。
関数が失敗した場合、戻り値はゼロです。拡張エラー情報を取得するには、GetLastError を呼び出します。
以前の値がゼロで、かつ関数が成功した場合、戻り値はゼロになりますが、関数は最後のエラー情報をクリアしません。成功または失敗を判定するには、SetLastError を 0 で呼び出して最後のエラー情報をクリアしてから、SetWindowLongPtr を呼び出します。関数の失敗は、戻り値がゼロであり、かつ GetLastError の結果が非ゼロであることで示されます。
解説(Remarks)
一部のウィンドウデータはキャッシュされるため、SetWindowLongPtr を使用して行った変更は、SetWindowPos 関数を呼び出すまで反映されません。
GWLP_WNDPROC インデックスを指定して SetWindowLongPtr を使用しウィンドウプロシージャを置き換える場合、そのウィンドウプロシージャは WindowProc コールバック関数の説明で指定されたガイドラインに準拠している必要があります。
DWLP_MSGRESULT インデックスを指定して SetWindowLongPtr を使用し、ダイアログボックスプロシージャで処理されたメッセージの戻り値を設定する場合、ダイアログボックスプロシージャはその直後に TRUE を返す必要があります。そうしないと、ダイアログボックスプロシージャがウィンドウメッセージを受け取る結果となる関数を呼び出した場合に、ネストされたウィンドウメッセージによって、DWLP_MSGRESULT を使用して設定した戻り値が上書きされる可能性があります。
GWLP_WNDPROC インデックスを指定して SetWindowLongPtr を呼び出すと、ウィンドウの作成に使用されたウィンドウクラスのサブクラスが作成されます。アプリケーションはシステムクラスをサブクラス化できますが、別のプロセスによって作成されたウィンドウクラスをサブクラス化すべきではありません。SetWindowLongPtr 関数は、特定のウィンドウクラスに関連付けられたウィンドウプロシージャを変更することでウィンドウサブクラスを作成し、システムが以前のウィンドウプロシージャの代わりに新しいウィンドウプロシージャを呼び出すようにします。新しいウィンドウプロシージャで処理されなかったメッセージは、CallWindowProc を呼び出して以前のウィンドウプロシージャに渡す必要があります。これにより、アプリケーションはウィンドウプロシージャのチェーンを作成できます。
追加ウィンドウメモリを予約するには、RegisterClassEx 関数で使用する WNDCLASSEX 構造体の cbWndExtra メンバーに非ゼロの値を指定します。
子ウィンドウの親を変更するために、GWLP_HWNDPARENT インデックスを指定して SetWindowLongPtr を呼び出さないでください。代わりに SetParent 関数を使用してください。
GWLP_HWNDPARENT は、子ウィンドウの親を変更するためではなく、トップレベルウィンドウの所有者を変更するために使用されます。
ウィンドウは、親または所有者のいずれかを持つか、どちらも持たないことができますが、両方を同時に持つことは決してありません。
ウィンドウのクラススタイルが CS_CLASSDC または CS_PARENTDC の場合、拡張ウィンドウスタイル WS_EX_COMPOSITED または WS_EX_LAYERED を設定しないでください。
プログレスバーにスタイルを設定するために SetWindowLongPtr を呼び出すと、その位置がリセットされます。
winuser.h ヘッダーは、SetWindowLongPtr をエイリアスとして定義しており、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択します。エンコーディング非依存のエイリアスの使用を、エンコーディング非依存でないコードと混在させると、コンパイルエラーやランタイムエラーを引き起こす不一致が生じる可能性があります。詳細については、関数プロトタイプの規約を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// USER32.dll (ANSI / -A)
#include <windows.h>
INT_PTR SetWindowLongPtrA(
HWND hWnd,
WINDOW_LONG_PTR_INDEX nIndex,
INT_PTR dwNewLong
);[DllImport("USER32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern IntPtr SetWindowLongPtrA(
IntPtr hWnd, // HWND
int nIndex, // WINDOW_LONG_PTR_INDEX
IntPtr dwNewLong // INT_PTR
);<DllImport("USER32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetWindowLongPtrA(
hWnd As IntPtr, ' HWND
nIndex As Integer, ' WINDOW_LONG_PTR_INDEX
dwNewLong As IntPtr ' INT_PTR
) As IntPtr
End Function' hWnd : HWND
' nIndex : WINDOW_LONG_PTR_INDEX
' dwNewLong : INT_PTR
Declare PtrSafe Function SetWindowLongPtrA 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
SetWindowLongPtrA = ctypes.windll.user32.SetWindowLongPtrA
SetWindowLongPtrA.restype = ctypes.c_ssize_t
SetWindowLongPtrA.argtypes = [
wintypes.HANDLE, # hWnd : HWND
ctypes.c_int, # nIndex : WINDOW_LONG_PTR_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')
SetWindowLongPtrA = Fiddle::Function.new(
lib['SetWindowLongPtrA'],
[
Fiddle::TYPE_VOIDP, # hWnd : HWND
Fiddle::TYPE_INT, # nIndex : WINDOW_LONG_PTR_INDEX
Fiddle::TYPE_INTPTR_T, # dwNewLong : INT_PTR
],
Fiddle::TYPE_INTPTR_T)#[link(name = "user32")]
extern "system" {
fn SetWindowLongPtrA(
hWnd: *mut core::ffi::c_void, // HWND
nIndex: i32, // WINDOW_LONG_PTR_INDEX
dwNewLong: isize // INT_PTR
) -> isize;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("USER32.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern IntPtr SetWindowLongPtrA(IntPtr hWnd, int nIndex, IntPtr dwNewLong);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_SetWindowLongPtrA' -Namespace Win32 -PassThru
# $api::SetWindowLongPtrA(hWnd, nIndex, dwNewLong)#uselib "USER32.dll"
#func global SetWindowLongPtrA "SetWindowLongPtrA" sptr, sptr, sptr
; SetWindowLongPtrA hWnd, nIndex, dwNewLong ; 戻り値は stat
; hWnd : HWND -> "sptr"
; nIndex : WINDOW_LONG_PTR_INDEX -> "sptr"
; dwNewLong : INT_PTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "USER32.dll"
#cfunc global SetWindowLongPtrA "SetWindowLongPtrA" sptr, int, sptr
; res = SetWindowLongPtrA(hWnd, nIndex, dwNewLong)
; hWnd : HWND -> "sptr"
; nIndex : WINDOW_LONG_PTR_INDEX -> "int"
; dwNewLong : INT_PTR -> "sptr"; INT_PTR SetWindowLongPtrA(HWND hWnd, WINDOW_LONG_PTR_INDEX nIndex, INT_PTR dwNewLong)
#uselib "USER32.dll"
#cfunc global SetWindowLongPtrA "SetWindowLongPtrA" intptr, int, intptr
; res = SetWindowLongPtrA(hWnd, nIndex, dwNewLong)
; hWnd : HWND -> "intptr"
; nIndex : WINDOW_LONG_PTR_INDEX -> "int"
; dwNewLong : INT_PTR -> "intptr"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
user32 = windows.NewLazySystemDLL("USER32.dll")
procSetWindowLongPtrA = user32.NewProc("SetWindowLongPtrA")
)
// hWnd (HWND), nIndex (WINDOW_LONG_PTR_INDEX), dwNewLong (INT_PTR)
r1, _, err := procSetWindowLongPtrA.Call(
uintptr(hWnd),
uintptr(nIndex),
uintptr(dwNewLong),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // INT_PTRfunction SetWindowLongPtrA(
hWnd: THandle; // HWND
nIndex: Integer; // WINDOW_LONG_PTR_INDEX
dwNewLong: NativeInt // INT_PTR
): NativeInt; stdcall;
external 'USER32.dll' name 'SetWindowLongPtrA';result := DllCall("USER32\SetWindowLongPtrA"
, "Ptr", hWnd ; HWND
, "Int", nIndex ; WINDOW_LONG_PTR_INDEX
, "Ptr", dwNewLong ; INT_PTR
, "Ptr") ; return: INT_PTR●SetWindowLongPtrA(hWnd, nIndex, dwNewLong) = DLL("USER32.dll", "int SetWindowLongPtrA(void*, int, int)")
# 呼び出し: SetWindowLongPtrA(hWnd, nIndex, dwNewLong)
# hWnd : HWND -> "void*"
# nIndex : WINDOW_LONG_PTR_INDEX -> "int"
# dwNewLong : INT_PTR -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "user32" fn SetWindowLongPtrA(
hWnd: ?*anyopaque, // HWND
nIndex: i32, // WINDOW_LONG_PTR_INDEX
dwNewLong: isize // INT_PTR
) callconv(std.os.windows.WINAPI) isize;proc SetWindowLongPtrA(
hWnd: pointer, # HWND
nIndex: int32, # WINDOW_LONG_PTR_INDEX
dwNewLong: int # INT_PTR
): int {.importc: "SetWindowLongPtrA", stdcall, dynlib: "USER32.dll".}pragma(lib, "user32");
extern(Windows)
ptrdiff_t SetWindowLongPtrA(
void* hWnd, // HWND
int nIndex, // WINDOW_LONG_PTR_INDEX
ptrdiff_t dwNewLong // INT_PTR
);ccall((:SetWindowLongPtrA, "USER32.dll"), stdcall, Int,
(Ptr{Cvoid}, Int32, Int),
hWnd, nIndex, dwNewLong)
# hWnd : HWND -> Ptr{Cvoid}
# nIndex : WINDOW_LONG_PTR_INDEX -> Int32
# dwNewLong : INT_PTR -> Int
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
intptr_t SetWindowLongPtrA(
void* hWnd,
int32_t nIndex,
intptr_t dwNewLong);
]]
local user32 = ffi.load("user32")
-- user32.SetWindowLongPtrA(hWnd, nIndex, dwNewLong)
-- hWnd : HWND
-- nIndex : WINDOW_LONG_PTR_INDEX
-- dwNewLong : INT_PTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('USER32.dll');
const SetWindowLongPtrA = lib.func('__stdcall', 'SetWindowLongPtrA', 'intptr_t', ['void *', 'int32_t', 'intptr_t']);
// SetWindowLongPtrA(hWnd, nIndex, dwNewLong)
// hWnd : HWND -> 'void *'
// nIndex : WINDOW_LONG_PTR_INDEX -> 'int32_t'
// dwNewLong : INT_PTR -> 'intptr_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("USER32.dll", {
SetWindowLongPtrA: { parameters: ["pointer", "i32", "isize"], result: "isize" },
});
// lib.symbols.SetWindowLongPtrA(hWnd, nIndex, dwNewLong)
// hWnd : HWND -> "pointer"
// nIndex : WINDOW_LONG_PTR_INDEX -> "i32"
// dwNewLong : INT_PTR -> "isize"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
intptr_t SetWindowLongPtrA(
void* hWnd,
int32_t nIndex,
intptr_t dwNewLong);
C, "USER32.dll");
// $ffi->SetWindowLongPtrA(hWnd, nIndex, dwNewLong);
// hWnd : HWND
// nIndex : WINDOW_LONG_PTR_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 SetWindowLongPtrA(
Pointer hWnd, // HWND
int nIndex, // WINDOW_LONG_PTR_INDEX
long dwNewLong // INT_PTR
);
}@[Link("user32")]
lib LibUSER32
fun SetWindowLongPtrA = SetWindowLongPtrA(
hWnd : Void*, # HWND
nIndex : Int32, # WINDOW_LONG_PTR_INDEX
dwNewLong : LibC::SSizeT # INT_PTR
) : LibC::SSizeT
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef SetWindowLongPtrANative = IntPtr Function(Pointer<Void>, Int32, IntPtr);
typedef SetWindowLongPtrADart = int Function(Pointer<Void>, int, int);
final SetWindowLongPtrA = DynamicLibrary.open('USER32.dll')
.lookupFunction<SetWindowLongPtrANative, SetWindowLongPtrADart>('SetWindowLongPtrA');
// hWnd : HWND -> Pointer<Void>
// nIndex : WINDOW_LONG_PTR_INDEX -> Int32
// dwNewLong : INT_PTR -> IntPtr
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function SetWindowLongPtrA(
hWnd: THandle; // HWND
nIndex: Integer; // WINDOW_LONG_PTR_INDEX
dwNewLong: NativeInt // INT_PTR
): NativeInt; stdcall;
external 'USER32.dll' name 'SetWindowLongPtrA';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "SetWindowLongPtrA"
c_SetWindowLongPtrA :: Ptr () -> Int32 -> CIntPtr -> IO CIntPtr
-- hWnd : HWND -> Ptr ()
-- nIndex : WINDOW_LONG_PTR_INDEX -> Int32
-- dwNewLong : INT_PTR -> CIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let setwindowlongptra =
foreign "SetWindowLongPtrA"
((ptr void) @-> int32_t @-> intptr_t @-> returning intptr_t)
(* hWnd : HWND -> (ptr void) *)
(* nIndex : WINDOW_LONG_PTR_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 ("SetWindowLongPtrA" set-window-long-ptr-a :convention :stdcall) :int64
(h-wnd :pointer) ; HWND
(n-index :int32) ; WINDOW_LONG_PTR_INDEX
(dw-new-long :int64)) ; INT_PTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $SetWindowLongPtrA = Win32::API::More->new('USER32',
'LPARAM SetWindowLongPtrA(HANDLE hWnd, int nIndex, LPARAM dwNewLong)');
# my $ret = $SetWindowLongPtrA->Call($hWnd, $nIndex, $dwNewLong);
# hWnd : HWND -> HANDLE
# nIndex : WINDOW_LONG_PTR_INDEX -> int
# dwNewLong : INT_PTR -> LPARAM
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f SetWindowLongPtrW (Unicode版) — ウィンドウの指定情報をポインタ幅で設定する(Unicode)。
- f CallWindowProcA — 指定のウィンドウプロシージャを呼び出す(ANSI)。
- f GetWindowLongPtrA — ウィンドウの指定情報をポインタ幅で取得する(ANSI)。
- f RegisterClassExA — 拡張属性付きでウィンドウクラスを登録する(ANSI)。
- f SetParent — 子ウィンドウの親ウィンドウを変更する。
- s WNDCLASSEXA
- c WNDPROC