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