GetWindowLongW
関数シグネチャ
// USER32.dll (Unicode / -W)
#include <windows.h>
INT GetWindowLongW(
HWND hWnd,
WINDOW_LONG_PTR_INDEX nIndex
);パラメーター
| 名前 | 型 | 方向 | 説明 | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| hWnd | HWND | in | ウィンドウへのハンドル。間接的に、そのウィンドウが属するクラスへのハンドルでもあります。 | ||||||||||||||||||||||||
| nIndex | WINDOW_LONG_PTR_INDEX | in | 取得する値への 0 から始まるオフセットです。有効な値は、0 から追加ウィンドウメモリのバイト数から 4 を引いた値までの範囲です。たとえば、12 バイト以上の追加メモリを指定した場合、値 8 は 3 番目の 32 ビット整数へのインデックスになります。それ以外の値を取得するには、次のいずれかの値を指定します。
hWnd パラメーターがダイアログボックスを指定している場合は、次の値も使用できます。
|
戻り値の型: INT
公式ドキュメント
指定したウィンドウに関する情報を取得します。(GetWindowLongW)
戻り値
型: LONG
関数が成功した場合、戻り値は要求された値です。
関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、GetLastError を呼び出します。
これまでに SetWindowLong が呼び出されていない場合、GetWindowLong は追加ウィンドウメモリまたは追加クラスメモリ内の値として 0 を返します。
解説(Remarks)
追加ウィンドウメモリを確保するには、RegisterClassEx 関数で使用する WNDCLASSEX 構造体の cbWndExtra メンバーに 0 以外の値を指定します。
例
例については、子ウィンドウの作成、列挙、およびサイズ変更を参照してください。
winuser.h ヘッダーは GetWindowLong をエイリアスとして定義しており、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択します。エンコード中立のエイリアスを、エンコード中立でないコードと混在して使用すると、不一致が生じ、コンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、関数プロトタイプの規約を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// USER32.dll (Unicode / -W)
#include <windows.h>
INT GetWindowLongW(
HWND hWnd,
WINDOW_LONG_PTR_INDEX nIndex
);[DllImport("USER32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern int GetWindowLongW(
IntPtr hWnd, // HWND
int nIndex // WINDOW_LONG_PTR_INDEX
);<DllImport("USER32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetWindowLongW(
hWnd As IntPtr, ' HWND
nIndex As Integer ' WINDOW_LONG_PTR_INDEX
) As Integer
End Function' hWnd : HWND
' nIndex : WINDOW_LONG_PTR_INDEX
Declare PtrSafe Function GetWindowLongW Lib "user32" ( _
ByVal hWnd As LongPtr, _
ByVal nIndex 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
GetWindowLongW = ctypes.windll.user32.GetWindowLongW
GetWindowLongW.restype = ctypes.c_int
GetWindowLongW.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')
GetWindowLongW = Fiddle::Function.new(
lib['GetWindowLongW'],
[
Fiddle::TYPE_VOIDP, # hWnd : HWND
Fiddle::TYPE_INT, # nIndex : WINDOW_LONG_PTR_INDEX
],
Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"#[link(name = "user32")]
extern "system" {
fn GetWindowLongW(
hWnd: *mut core::ffi::c_void, // HWND
nIndex: i32 // WINDOW_LONG_PTR_INDEX
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("USER32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern int GetWindowLongW(IntPtr hWnd, int nIndex);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_GetWindowLongW' -Namespace Win32 -PassThru
# $api::GetWindowLongW(hWnd, nIndex)#uselib "USER32.dll"
#func global GetWindowLongW "GetWindowLongW" wptr, wptr
; GetWindowLongW hWnd, nIndex ; 戻り値は stat
; hWnd : HWND -> "wptr"
; nIndex : WINDOW_LONG_PTR_INDEX -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "USER32.dll"
#cfunc global GetWindowLongW "GetWindowLongW" sptr, int
; res = GetWindowLongW(hWnd, nIndex)
; hWnd : HWND -> "sptr"
; nIndex : WINDOW_LONG_PTR_INDEX -> "int"; INT GetWindowLongW(HWND hWnd, WINDOW_LONG_PTR_INDEX nIndex)
#uselib "USER32.dll"
#cfunc global GetWindowLongW "GetWindowLongW" intptr, int
; res = GetWindowLongW(hWnd, nIndex)
; hWnd : HWND -> "intptr"
; nIndex : WINDOW_LONG_PTR_INDEX -> "int"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
user32 = windows.NewLazySystemDLL("USER32.dll")
procGetWindowLongW = user32.NewProc("GetWindowLongW")
)
// hWnd (HWND), nIndex (WINDOW_LONG_PTR_INDEX)
r1, _, err := procGetWindowLongW.Call(
uintptr(hWnd),
uintptr(nIndex),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // INTfunction GetWindowLongW(
hWnd: THandle; // HWND
nIndex: Integer // WINDOW_LONG_PTR_INDEX
): Integer; stdcall;
external 'USER32.dll' name 'GetWindowLongW';result := DllCall("USER32\GetWindowLongW"
, "Ptr", hWnd ; HWND
, "Int", nIndex ; WINDOW_LONG_PTR_INDEX
, "Int") ; return: INT●GetWindowLongW(hWnd, nIndex) = DLL("USER32.dll", "int GetWindowLongW(void*, int)")
# 呼び出し: GetWindowLongW(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 GetWindowLongW(
hWnd: ?*anyopaque, // HWND
nIndex: i32 // WINDOW_LONG_PTR_INDEX
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。proc GetWindowLongW(
hWnd: pointer, # HWND
nIndex: int32 # WINDOW_LONG_PTR_INDEX
): int32 {.importc: "GetWindowLongW", stdcall, dynlib: "USER32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。pragma(lib, "user32");
extern(Windows)
int GetWindowLongW(
void* hWnd, // HWND
int nIndex // WINDOW_LONG_PTR_INDEX
);ccall((:GetWindowLongW, "USER32.dll"), stdcall, Int32,
(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[[
int32_t GetWindowLongW(
void* hWnd,
int32_t nIndex);
]]
local user32 = ffi.load("user32")
-- user32.GetWindowLongW(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 GetWindowLongW = lib.func('__stdcall', 'GetWindowLongW', 'int32_t', ['void *', 'int32_t']);
// GetWindowLongW(hWnd, nIndex)
// hWnd : HWND -> 'void *'
// nIndex : WINDOW_LONG_PTR_INDEX -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("USER32.dll", {
GetWindowLongW: { parameters: ["pointer", "i32"], result: "i32" },
});
// lib.symbols.GetWindowLongW(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
int32_t GetWindowLongW(
void* hWnd,
int32_t nIndex);
C, "USER32.dll");
// $ffi->GetWindowLongW(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);
int GetWindowLongW(
Pointer hWnd, // HWND
int nIndex // WINDOW_LONG_PTR_INDEX
);
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。@[Link("user32")]
lib LibUSER32
fun GetWindowLongW = GetWindowLongW(
hWnd : Void*, # HWND
nIndex : Int32 # WINDOW_LONG_PTR_INDEX
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef GetWindowLongWNative = Int32 Function(Pointer<Void>, Int32);
typedef GetWindowLongWDart = int Function(Pointer<Void>, int);
final GetWindowLongW = DynamicLibrary.open('USER32.dll')
.lookupFunction<GetWindowLongWNative, GetWindowLongWDart>('GetWindowLongW');
// hWnd : HWND -> Pointer<Void>
// nIndex : WINDOW_LONG_PTR_INDEX -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function GetWindowLongW(
hWnd: THandle; // HWND
nIndex: Integer // WINDOW_LONG_PTR_INDEX
): Integer; stdcall;
external 'USER32.dll' name 'GetWindowLongW';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "GetWindowLongW"
c_GetWindowLongW :: Ptr () -> Int32 -> IO Int32
-- hWnd : HWND -> Ptr ()
-- nIndex : WINDOW_LONG_PTR_INDEX -> Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let getwindowlongw =
foreign "GetWindowLongW"
((ptr void) @-> int32_t @-> returning int32_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 ("GetWindowLongW" get-window-long-w :convention :stdcall) :int32
(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 $GetWindowLongW = Win32::API::More->new('USER32',
'int GetWindowLongW(HANDLE hWnd, int nIndex)');
# my $ret = $GetWindowLongW->Call($hWnd, $nIndex);
# hWnd : HWND -> HANDLE
# nIndex : WINDOW_LONG_PTR_INDEX -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。関連項目
- f GetWindowLongA (ANSI版) — ウィンドウの属性やスタイル値を取得する(ANSI版)。
- f CallWindowProcW — 指定のウィンドウプロシージャを呼び出す(Unicode)。
- f GetWindowLongPtrW — ウィンドウの指定情報をポインタ幅で取得する(Unicode)。
- f RegisterClassExW — 拡張属性付きでウィンドウクラスを登録する(Unicode)。
- f SetParent — 子ウィンドウの親ウィンドウを変更する。
- f SetWindowLongW — ウィンドウの属性やスタイル値を設定する(Unicode版)。
- s WNDCLASSW