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

GetWindowLongPtrW

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

シグネチャ

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

INT_PTR GetWindowLongPtrW(
    HWND hWnd,
    WINDOW_LONG_PTR_INDEX nIndex
);

パラメーター

名前方向説明
hWndHWNDinウィンドウへのハンドル、および間接的にそのウィンドウが属するクラスへのハンドルです。
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
ウィンドウプロシージャへのポインター、またはウィンドウプロシージャへのポインターを表すハンドルを取得します。ウィンドウプロシージャを呼び出すには、CallWindowProc 関数を使用する必要があります。

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

意味
DWLP_DLGPROC
DWLP_MSGRESULT + sizeof(LRESULT)
ダイアログボックスプロシージャへのポインター、またはダイアログボックスプロシージャへのポインターを表すハンドルを取得します。ダイアログボックスプロシージャを呼び出すには、CallWindowProc 関数を使用する必要があります。
DWLP_MSGRESULT
0
ダイアログボックスプロシージャで処理されたメッセージの戻り値を取得します。
DWLP_USER
DWLP_DLGPROC + sizeof(DLGPROC)
ハンドルやポインターなど、アプリケーション固有の追加情報を取得します。

戻り値の型: INT_PTR

公式ドキュメント

指定したウィンドウに関する情報を取得します。この関数は、追加のウィンドウメモリ内の指定したオフセットにある値も取得します。(Unicode)

戻り値

型: LONG_PTR

関数が成功した場合、戻り値は要求された値です。

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

SetWindowLong または SetWindowLongPtr が以前に呼び出されていない場合、GetWindowLongPtr は追加のウィンドウメモリまたはクラスメモリ内の値として 0 を返します。

解説(Remarks)

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

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 GetWindowLongPtrW(
    HWND hWnd,
    WINDOW_LONG_PTR_INDEX nIndex
);
[DllImport("USER32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern IntPtr GetWindowLongPtrW(
    IntPtr hWnd,   // HWND
    int nIndex   // WINDOW_LONG_PTR_INDEX
);
<DllImport("USER32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetWindowLongPtrW(
    hWnd As IntPtr,   ' HWND
    nIndex As Integer   ' WINDOW_LONG_PTR_INDEX
) As IntPtr
End Function
' hWnd : HWND
' nIndex : WINDOW_LONG_PTR_INDEX
Declare PtrSafe Function GetWindowLongPtrW Lib "user32" ( _
    ByVal hWnd As LongPtr, _
    ByVal nIndex As Long) 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

GetWindowLongPtrW = ctypes.windll.user32.GetWindowLongPtrW
GetWindowLongPtrW.restype = ctypes.c_ssize_t
GetWindowLongPtrW.argtypes = [
    wintypes.HANDLE,  # hWnd : HWND
    ctypes.c_int,  # nIndex : WINDOW_LONG_PTR_INDEX
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
GetWindowLongPtrW = Fiddle::Function.new(
  lib['GetWindowLongPtrW'],
  [
    Fiddle::TYPE_VOIDP,  # hWnd : HWND
    Fiddle::TYPE_INT,  # nIndex : WINDOW_LONG_PTR_INDEX
  ],
  Fiddle::TYPE_INTPTR_T)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "user32")]
extern "system" {
    fn GetWindowLongPtrW(
        hWnd: *mut core::ffi::c_void,  // HWND
        nIndex: i32  // WINDOW_LONG_PTR_INDEX
    ) -> isize;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("USER32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern IntPtr GetWindowLongPtrW(IntPtr hWnd, int nIndex);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_GetWindowLongPtrW' -Namespace Win32 -PassThru
# $api::GetWindowLongPtrW(hWnd, nIndex)
#uselib "USER32.dll"
#func global GetWindowLongPtrW "GetWindowLongPtrW" wptr, wptr
; GetWindowLongPtrW hWnd, nIndex   ; 戻り値は stat
; hWnd : HWND -> "wptr"
; nIndex : WINDOW_LONG_PTR_INDEX -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "USER32.dll"
#cfunc global GetWindowLongPtrW "GetWindowLongPtrW" sptr, int
; res = GetWindowLongPtrW(hWnd, nIndex)
; hWnd : HWND -> "sptr"
; nIndex : WINDOW_LONG_PTR_INDEX -> "int"
; INT_PTR GetWindowLongPtrW(HWND hWnd, WINDOW_LONG_PTR_INDEX nIndex)
#uselib "USER32.dll"
#cfunc global GetWindowLongPtrW "GetWindowLongPtrW" intptr, int
; res = GetWindowLongPtrW(hWnd, nIndex)
; hWnd : HWND -> "intptr"
; nIndex : WINDOW_LONG_PTR_INDEX -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procGetWindowLongPtrW = user32.NewProc("GetWindowLongPtrW")
)

// hWnd (HWND), nIndex (WINDOW_LONG_PTR_INDEX)
r1, _, err := procGetWindowLongPtrW.Call(
	uintptr(hWnd),
	uintptr(nIndex),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT_PTR
function GetWindowLongPtrW(
  hWnd: THandle;   // HWND
  nIndex: Integer   // WINDOW_LONG_PTR_INDEX
): NativeInt; stdcall;
  external 'USER32.dll' name 'GetWindowLongPtrW';
result := DllCall("USER32\GetWindowLongPtrW"
    , "Ptr", hWnd   ; HWND
    , "Int", nIndex   ; WINDOW_LONG_PTR_INDEX
    , "Ptr")   ; return: INT_PTR
●GetWindowLongPtrW(hWnd, nIndex) = DLL("USER32.dll", "int GetWindowLongPtrW(void*, int)")
# 呼び出し: GetWindowLongPtrW(hWnd, nIndex)
# hWnd : HWND -> "void*"
# nIndex : WINDOW_LONG_PTR_INDEX -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "user32" fn GetWindowLongPtrW(
    hWnd: ?*anyopaque, // HWND
    nIndex: i32 // WINDOW_LONG_PTR_INDEX
) callconv(std.os.windows.WINAPI) isize;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc GetWindowLongPtrW(
    hWnd: pointer,  # HWND
    nIndex: int32  # WINDOW_LONG_PTR_INDEX
): int {.importc: "GetWindowLongPtrW", stdcall, dynlib: "USER32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "user32");
extern(Windows)
ptrdiff_t GetWindowLongPtrW(
    void* hWnd,   // HWND
    int nIndex   // WINDOW_LONG_PTR_INDEX
);
ccall((:GetWindowLongPtrW, "USER32.dll"), stdcall, Int,
      (Ptr{Cvoid}, Int32),
      hWnd, nIndex)
# hWnd : HWND -> Ptr{Cvoid}
# nIndex : WINDOW_LONG_PTR_INDEX -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
intptr_t GetWindowLongPtrW(
    void* hWnd,
    int32_t nIndex);
]]
local user32 = ffi.load("user32")
-- user32.GetWindowLongPtrW(hWnd, nIndex)
-- hWnd : HWND
-- nIndex : WINDOW_LONG_PTR_INDEX
-- 構造体/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 GetWindowLongPtrW = lib.func('__stdcall', 'GetWindowLongPtrW', 'intptr_t', ['void *', 'int32_t']);
// GetWindowLongPtrW(hWnd, nIndex)
// hWnd : HWND -> 'void *'
// nIndex : WINDOW_LONG_PTR_INDEX -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("USER32.dll", {
  GetWindowLongPtrW: { parameters: ["pointer", "i32"], result: "isize" },
});
// lib.symbols.GetWindowLongPtrW(hWnd, nIndex)
// hWnd : HWND -> "pointer"
// nIndex : WINDOW_LONG_PTR_INDEX -> "i32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
intptr_t GetWindowLongPtrW(
    void* hWnd,
    int32_t nIndex);
C, "USER32.dll");
// $ffi->GetWindowLongPtrW(hWnd, nIndex);
// hWnd : HWND
// nIndex : WINDOW_LONG_PTR_INDEX
// 構造体/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 GetWindowLongPtrW(
        Pointer hWnd,   // HWND
        int nIndex   // WINDOW_LONG_PTR_INDEX
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("user32")]
lib LibUSER32
  fun GetWindowLongPtrW = GetWindowLongPtrW(
    hWnd : Void*,   # HWND
    nIndex : Int32   # WINDOW_LONG_PTR_INDEX
  ) : LibC::SSizeT
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef GetWindowLongPtrWNative = IntPtr Function(Pointer<Void>, Int32);
typedef GetWindowLongPtrWDart = int Function(Pointer<Void>, int);
final GetWindowLongPtrW = DynamicLibrary.open('USER32.dll')
    .lookupFunction<GetWindowLongPtrWNative, GetWindowLongPtrWDart>('GetWindowLongPtrW');
// hWnd : HWND -> Pointer<Void>
// nIndex : WINDOW_LONG_PTR_INDEX -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetWindowLongPtrW(
  hWnd: THandle;   // HWND
  nIndex: Integer   // WINDOW_LONG_PTR_INDEX
): NativeInt; stdcall;
  external 'USER32.dll' name 'GetWindowLongPtrW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetWindowLongPtrW"
  c_GetWindowLongPtrW :: Ptr () -> Int32 -> IO CIntPtr
-- hWnd : HWND -> Ptr ()
-- nIndex : WINDOW_LONG_PTR_INDEX -> Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getwindowlongptrw =
  foreign "GetWindowLongPtrW"
    ((ptr void) @-> int32_t @-> returning intptr_t)
(* hWnd : HWND -> (ptr void) *)
(* nIndex : WINDOW_LONG_PTR_INDEX -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)

(cffi:defcfun ("GetWindowLongPtrW" get-window-long-ptr-w :convention :stdcall) :int64
  (h-wnd :pointer)   ; HWND
  (n-index :int32))   ; WINDOW_LONG_PTR_INDEX
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetWindowLongPtrW = Win32::API::More->new('USER32',
    'LPARAM GetWindowLongPtrW(HANDLE hWnd, int nIndex)');
# my $ret = $GetWindowLongPtrW->Call($hWnd, $nIndex);
# hWnd : HWND -> HANDLE
# nIndex : WINDOW_LONG_PTR_INDEX -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

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