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

SetWindowLongA

関数
ウィンドウの属性やスタイル値を設定する(ANSI版)。
DLLUSER32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// USER32.dll  (ANSI / -A)
#include <windows.h>

INT SetWindowLongA(
    HWND hWnd,
    WINDOW_LONG_PTR_INDEX nIndex,
    INT dwNewLong
);

パラメーター

名前方向説明
hWndHWNDinウィンドウへのハンドル。間接的に、そのウィンドウが属するクラスを指定します。
nIndexWINDOW_LONG_PTR_INDEXin

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

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

ウィンドウが呼び出し元スレッドと同じプロセスに属していない場合、この属性を変更することはできません。

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

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

戻り値の型: INT

公式ドキュメント

指定したウィンドウの属性を変更します。この関数は、ウィンドウの追加メモリ内の指定したオフセットにある 32 ビット (long) の値も設定します。(ANSI)

戻り値

型: LONG

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

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

指定した 32 ビット整数の以前の値が 0 で、かつ関数が成功した場合、戻り値は 0 になりますが、関数は直近のエラー情報をクリアしません。このため、成功と失敗を判別することが難しくなります。これに対処するには、SetWindowLong を呼び出す前に SetLastError を 0 で呼び出し、直近のエラー情報をクリアしておく必要があります。これにより、関数の失敗は戻り値 0 かつ GetLastError の結果が 0 以外であることによって示されます。

解説(Remarks)

一部のウィンドウデータはキャッシュされるため、SetWindowLong で行った変更は SetWindowPos 関数を呼び出すまで反映されません。具体的には、フレームスタイルのいずれかを変更した場合は、キャッシュが正しく更新されるように、SWP_FRAMECHANGED フラグを指定して SetWindowPos を呼び出す必要があります。

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

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

GWL_WNDPROC インデックスを指定して SetWindowLong を呼び出すと、ウィンドウの作成に使用されたウィンドウクラスのサブクラスが作成されます。アプリケーションはシステムクラスをサブクラス化できますが、別のプロセスによって作成されたウィンドウクラスをサブクラス化すべきではありません。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 の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// USER32.dll  (ANSI / -A)
#include <windows.h>

INT SetWindowLongA(
    HWND hWnd,
    WINDOW_LONG_PTR_INDEX nIndex,
    INT dwNewLong
);
[DllImport("USER32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern int SetWindowLongA(
    IntPtr hWnd,   // HWND
    int nIndex,   // WINDOW_LONG_PTR_INDEX
    int dwNewLong   // INT
);
<DllImport("USER32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetWindowLongA(
    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 SetWindowLongA Lib "user32" ( _
    ByVal hWnd As LongPtr, _
    ByVal nIndex As Long, _
    ByVal dwNewLong As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SetWindowLongA = ctypes.windll.user32.SetWindowLongA
SetWindowLongA.restype = ctypes.c_int
SetWindowLongA.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')
SetWindowLongA = Fiddle::Function.new(
  lib['SetWindowLongA'],
  [
    Fiddle::TYPE_VOIDP,  # hWnd : HWND
    Fiddle::TYPE_INT,  # nIndex : WINDOW_LONG_PTR_INDEX
    Fiddle::TYPE_INT,  # dwNewLong : INT
  ],
  Fiddle::TYPE_INT)
#[link(name = "user32")]
extern "system" {
    fn SetWindowLongA(
        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.Ansi, SetLastError = true)]
public static extern int SetWindowLongA(IntPtr hWnd, int nIndex, int dwNewLong);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_SetWindowLongA' -Namespace Win32 -PassThru
# $api::SetWindowLongA(hWnd, nIndex, dwNewLong)
#uselib "USER32.dll"
#func global SetWindowLongA "SetWindowLongA" sptr, sptr, sptr
; SetWindowLongA hWnd, nIndex, dwNewLong   ; 戻り値は stat
; hWnd : HWND -> "sptr"
; nIndex : WINDOW_LONG_PTR_INDEX -> "sptr"
; dwNewLong : INT -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "USER32.dll"
#cfunc global SetWindowLongA "SetWindowLongA" sptr, int, int
; res = SetWindowLongA(hWnd, nIndex, dwNewLong)
; hWnd : HWND -> "sptr"
; nIndex : WINDOW_LONG_PTR_INDEX -> "int"
; dwNewLong : INT -> "int"
; INT SetWindowLongA(HWND hWnd, WINDOW_LONG_PTR_INDEX nIndex, INT dwNewLong)
#uselib "USER32.dll"
#cfunc global SetWindowLongA "SetWindowLongA" intptr, int, int
; res = SetWindowLongA(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")
	procSetWindowLongA = user32.NewProc("SetWindowLongA")
)

// hWnd (HWND), nIndex (WINDOW_LONG_PTR_INDEX), dwNewLong (INT)
r1, _, err := procSetWindowLongA.Call(
	uintptr(hWnd),
	uintptr(nIndex),
	uintptr(dwNewLong),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function SetWindowLongA(
  hWnd: THandle;   // HWND
  nIndex: Integer;   // WINDOW_LONG_PTR_INDEX
  dwNewLong: Integer   // INT
): Integer; stdcall;
  external 'USER32.dll' name 'SetWindowLongA';
result := DllCall("USER32\SetWindowLongA"
    , "Ptr", hWnd   ; HWND
    , "Int", nIndex   ; WINDOW_LONG_PTR_INDEX
    , "Int", dwNewLong   ; INT
    , "Int")   ; return: INT
●SetWindowLongA(hWnd, nIndex, dwNewLong) = DLL("USER32.dll", "int SetWindowLongA(void*, int, int)")
# 呼び出し: SetWindowLongA(hWnd, nIndex, dwNewLong)
# hWnd : HWND -> "void*"
# nIndex : WINDOW_LONG_PTR_INDEX -> "int"
# dwNewLong : INT -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "user32" fn SetWindowLongA(
    hWnd: ?*anyopaque, // HWND
    nIndex: i32, // WINDOW_LONG_PTR_INDEX
    dwNewLong: i32 // INT
) callconv(std.os.windows.WINAPI) i32;
proc SetWindowLongA(
    hWnd: pointer,  # HWND
    nIndex: int32,  # WINDOW_LONG_PTR_INDEX
    dwNewLong: int32  # INT
): int32 {.importc: "SetWindowLongA", stdcall, dynlib: "USER32.dll".}
pragma(lib, "user32");
extern(Windows)
int SetWindowLongA(
    void* hWnd,   // HWND
    int nIndex,   // WINDOW_LONG_PTR_INDEX
    int dwNewLong   // INT
);
ccall((:SetWindowLongA, "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 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SetWindowLongA(
    void* hWnd,
    int32_t nIndex,
    int32_t dwNewLong);
]]
local user32 = ffi.load("user32")
-- user32.SetWindowLongA(hWnd, nIndex, dwNewLong)
-- hWnd : HWND
-- nIndex : WINDOW_LONG_PTR_INDEX
-- dwNewLong : INT
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('USER32.dll');
const SetWindowLongA = lib.func('__stdcall', 'SetWindowLongA', 'int32_t', ['void *', 'int32_t', 'int32_t']);
// SetWindowLongA(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", {
  SetWindowLongA: { parameters: ["pointer", "i32", "i32"], result: "i32" },
});
// lib.symbols.SetWindowLongA(hWnd, nIndex, dwNewLong)
// hWnd : HWND -> "pointer"
// nIndex : WINDOW_LONG_PTR_INDEX -> "i32"
// dwNewLong : INT -> "i32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SetWindowLongA(
    void* hWnd,
    int32_t nIndex,
    int32_t dwNewLong);
C, "USER32.dll");
// $ffi->SetWindowLongA(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.ASCII_OPTIONS);
    int SetWindowLongA(
        Pointer hWnd,   // HWND
        int nIndex,   // WINDOW_LONG_PTR_INDEX
        int dwNewLong   // INT
    );
}
@[Link("user32")]
lib LibUSER32
  fun SetWindowLongA = SetWindowLongA(
    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 SetWindowLongANative = Int32 Function(Pointer<Void>, Int32, Int32);
typedef SetWindowLongADart = int Function(Pointer<Void>, int, int);
final SetWindowLongA = DynamicLibrary.open('USER32.dll')
    .lookupFunction<SetWindowLongANative, SetWindowLongADart>('SetWindowLongA');
// hWnd : HWND -> Pointer<Void>
// nIndex : WINDOW_LONG_PTR_INDEX -> Int32
// dwNewLong : INT -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetWindowLongA(
  hWnd: THandle;   // HWND
  nIndex: Integer;   // WINDOW_LONG_PTR_INDEX
  dwNewLong: Integer   // INT
): Integer; stdcall;
  external 'USER32.dll' name 'SetWindowLongA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetWindowLongA"
  c_SetWindowLongA :: 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 setwindowlonga =
  foreign "SetWindowLongA"
    ((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 ("SetWindowLongA" set-window-long-a :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 $SetWindowLongA = Win32::API::More->new('USER32',
    'int SetWindowLongA(HANDLE hWnd, int nIndex, int dwNewLong)');
# my $ret = $SetWindowLongA->Call($hWnd, $nIndex, $dwNewLong);
# hWnd : HWND -> HANDLE
# nIndex : WINDOW_LONG_PTR_INDEX -> int
# dwNewLong : INT -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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