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

SetWindowLongPtrW

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

シグネチャ

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

INT_PTR SetWindowLongPtrW(
    HWND hWnd,
    WINDOW_LONG_PTR_INDEX nIndex,
    INT_PTR dwNewLong
);

パラメーター

名前方向説明
hWndHWNDin

ウィンドウへのハンドル、および間接的にそのウィンドウが属するクラスへのハンドルです。hWnd パラメーターで指定したウィンドウを所有するプロセスが、呼び出し元スレッドが属するプロセスよりも UIPI 階層で高いプロセス権限を持つ場合、SetWindowLongPtr 関数は失敗します。

Windows XP/2000: hWnd パラメーターで指定したウィンドウが呼び出し元スレッドと同じプロセスに属していない場合、SetWindowLongPtr 関数は失敗します。

nIndexWINDOW_LONG_PTR_INDEXin

設定する値への 0 から始まるオフセットです。有効な値は、0 から、追加ウィンドウメモリのバイト数より LONG_PTR のサイズを引いた値までの範囲です。それ以外の値を設定するには、次のいずれかの値を指定します。

意味
GWL_EXSTYLE
-20
新しい拡張ウィンドウスタイルを設定します。
GWLP_HINSTANCE
-6
新しいアプリケーションインスタンスハンドルを設定します。
GWLP_HWNDPARENT
-8
トップレベルウィンドウに新しい所有者を設定します。
GWLP_ID
-12
子ウィンドウの新しい識別子を設定します。このウィンドウをトップレベルウィンドウにすることはできません。
GWL_STYLE
-16
新しいウィンドウスタイルを設定します。
GWLP_USERDATA
-21
ウィンドウに関連付けられたユーザーデータを設定します。このデータは、ウィンドウを作成したアプリケーションが使用することを意図しています。初期値は 0 です。
GWLP_WNDPROC
-4
ウィンドウプロシージャの新しいアドレスを設定します。

hWnd パラメーターがダイアログボックスを示す場合は、次の値も使用できます。

意味
DWLP_DLGPROC
DWLP_MSGRESULT + sizeof(LRESULT)
ダイアログボックスプロシージャへの新しいポインターを設定します。
DWLP_MSGRESULT
0
ダイアログボックスプロシージャで処理されたメッセージの戻り値を設定します。
DWLP_USER
DWLP_DLGPROC + sizeof(DLGPROC)
ハンドルやポインターなど、アプリケーション固有の新しい追加情報を設定します。
dwNewLongINT_PTRin置き換える値です。

戻り値の型: INT_PTR

公式ドキュメント

指定したウィンドウの属性を変更します。(Unicode)

戻り値

型: LONG_PTR

関数が成功した場合、戻り値は指定したオフセットの以前の値です。

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

以前の値が 0 で関数が成功した場合、戻り値は 0 になりますが、関数は最後のエラー情報をクリアしません。成功か失敗かを判別するには、SetLastError を 0 で呼び出して最後のエラー情報をクリアしてから、SetWindowLongPtr を呼び出します。関数の失敗は、戻り値が 0 で、かつ GetLastError の結果が 0 以外であることで示されます。

解説(Remarks)

一部のウィンドウデータはキャッシュされるため、SetWindowLongPtr を使用して行った変更は、SetWindowPos 関数を呼び出すまで反映されません。

GWLP_WNDPROC インデックスを指定して SetWindowLongPtr でウィンドウプロシージャを置き換える場合、そのウィンドウプロシージャは WindowProc コールバック関数の説明で指定されているガイドラインに準拠している必要があります。

DWLP_MSGRESULT インデックスを指定して SetWindowLongPtr でダイアログボックスプロシージャが処理するメッセージの戻り値を設定する場合、ダイアログボックスプロシージャはその直後に TRUE を返す必要があります。そうしないと、ダイアログボックスプロシージャがウィンドウメッセージを受け取る原因となる関数を呼び出した場合、ネストされたウィンドウメッセージによって DWLP_MSGRESULT で設定した戻り値が上書きされる可能性があります。

GWLP_WNDPROC インデックスを指定して SetWindowLongPtr を呼び出すと、ウィンドウの作成に使用したウィンドウクラスのサブクラスが作成されます。アプリケーションはシステムクラスをサブクラス化できますが、別のプロセスが作成したウィンドウクラスをサブクラス化すべきではありません。SetWindowLongPtr 関数は、特定のウィンドウクラスに関連付けられたウィンドウプロシージャを変更することでウィンドウのサブクラスを作成し、システムが以前のウィンドウプロシージャの代わりに新しいウィンドウプロシージャを呼び出すようにします。アプリケーションは、新しいウィンドウプロシージャで処理されないメッセージを、CallWindowProc を呼び出して以前のウィンドウプロシージャに渡す必要があります。これにより、アプリケーションはウィンドウプロシージャのチェーンを作成できます。

追加ウィンドウメモリを確保するには、RegisterClassEx 関数で使用する WNDCLASSEX 構造体の cbWndExtra メンバーに 0 以外の値を指定します。

子ウィンドウの親を変更するために、GWLP_HWNDPARENT インデックスを指定して SetWindowLongPtr を呼び出さないでください。代わりに SetParent 関数を使用します。

GWLP_HWNDPARENT は、子ウィンドウの親ではなく、トップレベルウィンドウの所有者を変更するために使用されます。

ウィンドウは親または所有者のいずれか、あるいはそのどちらも持たない場合がありますが、両方を同時に持つことはありません。

ウィンドウのクラススタイルが CS_CLASSDC または CS_PARENTDC の場合、拡張ウィンドウスタイル WS_EX_COMPOSITED または WS_EX_LAYERED を設定しないでください。

プログレスバーにスタイルを設定するために SetWindowLongPtr を呼び出すと、その位置がリセットされます。

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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>

INT_PTR SetWindowLongPtrW(
    HWND hWnd,
    WINDOW_LONG_PTR_INDEX nIndex,
    INT_PTR dwNewLong
);
[DllImport("USER32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern IntPtr SetWindowLongPtrW(
    IntPtr hWnd,   // HWND
    int nIndex,   // WINDOW_LONG_PTR_INDEX
    IntPtr dwNewLong   // INT_PTR
);
<DllImport("USER32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetWindowLongPtrW(
    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 SetWindowLongPtrW 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

SetWindowLongPtrW = ctypes.windll.user32.SetWindowLongPtrW
SetWindowLongPtrW.restype = ctypes.c_ssize_t
SetWindowLongPtrW.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')
SetWindowLongPtrW = Fiddle::Function.new(
  lib['SetWindowLongPtrW'],
  [
    Fiddle::TYPE_VOIDP,  # hWnd : HWND
    Fiddle::TYPE_INT,  # nIndex : WINDOW_LONG_PTR_INDEX
    Fiddle::TYPE_INTPTR_T,  # dwNewLong : INT_PTR
  ],
  Fiddle::TYPE_INTPTR_T)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "user32")]
extern "system" {
    fn SetWindowLongPtrW(
        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.Unicode, SetLastError = true)]
public static extern IntPtr SetWindowLongPtrW(IntPtr hWnd, int nIndex, IntPtr dwNewLong);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_SetWindowLongPtrW' -Namespace Win32 -PassThru
# $api::SetWindowLongPtrW(hWnd, nIndex, dwNewLong)
#uselib "USER32.dll"
#func global SetWindowLongPtrW "SetWindowLongPtrW" wptr, wptr, wptr
; SetWindowLongPtrW hWnd, nIndex, dwNewLong   ; 戻り値は stat
; hWnd : HWND -> "wptr"
; nIndex : WINDOW_LONG_PTR_INDEX -> "wptr"
; dwNewLong : INT_PTR -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "USER32.dll"
#cfunc global SetWindowLongPtrW "SetWindowLongPtrW" sptr, int, sptr
; res = SetWindowLongPtrW(hWnd, nIndex, dwNewLong)
; hWnd : HWND -> "sptr"
; nIndex : WINDOW_LONG_PTR_INDEX -> "int"
; dwNewLong : INT_PTR -> "sptr"
; INT_PTR SetWindowLongPtrW(HWND hWnd, WINDOW_LONG_PTR_INDEX nIndex, INT_PTR dwNewLong)
#uselib "USER32.dll"
#cfunc global SetWindowLongPtrW "SetWindowLongPtrW" intptr, int, intptr
; res = SetWindowLongPtrW(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")
	procSetWindowLongPtrW = user32.NewProc("SetWindowLongPtrW")
)

// hWnd (HWND), nIndex (WINDOW_LONG_PTR_INDEX), dwNewLong (INT_PTR)
r1, _, err := procSetWindowLongPtrW.Call(
	uintptr(hWnd),
	uintptr(nIndex),
	uintptr(dwNewLong),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT_PTR
function SetWindowLongPtrW(
  hWnd: THandle;   // HWND
  nIndex: Integer;   // WINDOW_LONG_PTR_INDEX
  dwNewLong: NativeInt   // INT_PTR
): NativeInt; stdcall;
  external 'USER32.dll' name 'SetWindowLongPtrW';
result := DllCall("USER32\SetWindowLongPtrW"
    , "Ptr", hWnd   ; HWND
    , "Int", nIndex   ; WINDOW_LONG_PTR_INDEX
    , "Ptr", dwNewLong   ; INT_PTR
    , "Ptr")   ; return: INT_PTR
●SetWindowLongPtrW(hWnd, nIndex, dwNewLong) = DLL("USER32.dll", "int SetWindowLongPtrW(void*, int, int)")
# 呼び出し: SetWindowLongPtrW(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)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "user32" fn SetWindowLongPtrW(
    hWnd: ?*anyopaque, // HWND
    nIndex: i32, // WINDOW_LONG_PTR_INDEX
    dwNewLong: isize // INT_PTR
) callconv(std.os.windows.WINAPI) isize;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc SetWindowLongPtrW(
    hWnd: pointer,  # HWND
    nIndex: int32,  # WINDOW_LONG_PTR_INDEX
    dwNewLong: int  # INT_PTR
): int {.importc: "SetWindowLongPtrW", stdcall, dynlib: "USER32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "user32");
extern(Windows)
ptrdiff_t SetWindowLongPtrW(
    void* hWnd,   // HWND
    int nIndex,   // WINDOW_LONG_PTR_INDEX
    ptrdiff_t dwNewLong   // INT_PTR
);
ccall((:SetWindowLongPtrW, "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 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
intptr_t SetWindowLongPtrW(
    void* hWnd,
    int32_t nIndex,
    intptr_t dwNewLong);
]]
local user32 = ffi.load("user32")
-- user32.SetWindowLongPtrW(hWnd, nIndex, dwNewLong)
-- hWnd : HWND
-- nIndex : WINDOW_LONG_PTR_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 SetWindowLongPtrW = lib.func('__stdcall', 'SetWindowLongPtrW', 'intptr_t', ['void *', 'int32_t', 'intptr_t']);
// SetWindowLongPtrW(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", {
  SetWindowLongPtrW: { parameters: ["pointer", "i32", "isize"], result: "isize" },
});
// lib.symbols.SetWindowLongPtrW(hWnd, nIndex, dwNewLong)
// hWnd : HWND -> "pointer"
// nIndex : WINDOW_LONG_PTR_INDEX -> "i32"
// dwNewLong : INT_PTR -> "isize"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
intptr_t SetWindowLongPtrW(
    void* hWnd,
    int32_t nIndex,
    intptr_t dwNewLong);
C, "USER32.dll");
// $ffi->SetWindowLongPtrW(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.UNICODE_OPTIONS);
    long SetWindowLongPtrW(
        Pointer hWnd,   // HWND
        int nIndex,   // WINDOW_LONG_PTR_INDEX
        long dwNewLong   // INT_PTR
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("user32")]
lib LibUSER32
  fun SetWindowLongPtrW = SetWindowLongPtrW(
    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 SetWindowLongPtrWNative = IntPtr Function(Pointer<Void>, Int32, IntPtr);
typedef SetWindowLongPtrWDart = int Function(Pointer<Void>, int, int);
final SetWindowLongPtrW = DynamicLibrary.open('USER32.dll')
    .lookupFunction<SetWindowLongPtrWNative, SetWindowLongPtrWDart>('SetWindowLongPtrW');
// hWnd : HWND -> Pointer<Void>
// nIndex : WINDOW_LONG_PTR_INDEX -> Int32
// dwNewLong : INT_PTR -> IntPtr
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetWindowLongPtrW(
  hWnd: THandle;   // HWND
  nIndex: Integer;   // WINDOW_LONG_PTR_INDEX
  dwNewLong: NativeInt   // INT_PTR
): NativeInt; stdcall;
  external 'USER32.dll' name 'SetWindowLongPtrW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetWindowLongPtrW"
  c_SetWindowLongPtrW :: 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 setwindowlongptrw =
  foreign "SetWindowLongPtrW"
    ((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 ("SetWindowLongPtrW" set-window-long-ptr-w :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 $SetWindowLongPtrW = Win32::API::More->new('USER32',
    'LPARAM SetWindowLongPtrW(HANDLE hWnd, int nIndex, LPARAM dwNewLong)');
# my $ret = $SetWindowLongPtrW->Call($hWnd, $nIndex, $dwNewLong);
# hWnd : HWND -> HANDLE
# nIndex : WINDOW_LONG_PTR_INDEX -> int
# dwNewLong : INT_PTR -> LPARAM
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

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