ホーム › UI.WindowsAndMessaging › GetWindowLongPtrA
GetWindowLongPtrA
関数ウィンドウの指定情報をポインタ幅で取得する(ANSI)。
シグネチャ
// USER32.dll (ANSI / -A)
#include <windows.h>
INT_PTR GetWindowLongPtrA(
HWND hWnd,
WINDOW_LONG_PTR_INDEX nIndex
);パラメーター
| 名前 | 型 | 方向 | 説明 | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| hWnd | HWND | in | ウィンドウへのハンドル。間接的に、そのウィンドウが属するクラスへのハンドルでもあります。 | ||||||||||||||||||||||||
| nIndex | WINDOW_LONG_PTR_INDEX | in | 取得する値への 0 から始まるオフセット。有効な値の範囲は、0 から、追加のウィンドウメモリのバイト数から LONG_PTR のサイズを引いた値までです。これ以外の値を取得するには、次のいずれかの値を指定します。
hWnd パラメーターがダイアログボックスを識別する場合は、次の値も使用できます。
|
戻り値の型: INT_PTR
公式ドキュメント
指定されたウィンドウに関する情報を取得します。この関数は、追加のウィンドウメモリ内の指定されたオフセットにある値も取得します。(ANSI)
戻り値
型: LONG_PTR
関数が成功した場合、戻り値は要求された値です。
関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、GetLastError を呼び出します。
SetWindowLong または SetWindowLongPtr が以前に呼び出されていない場合、GetWindowLongPtr は追加のウィンドウメモリまたはクラスメモリ内の値に対して 0 を返します。
解説(Remarks)
追加のウィンドウメモリを予約するには、RegisterClassEx 関数で使用する WNDCLASSEX 構造体の cbWndExtra メンバーに 0 以外の値を指定します。
メモ
winuser.h ヘッダーは GetWindowLongPtr をエイリアスとして定義しており、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択します。エンコーディングに依存しないエイリアスの使用を、エンコーディングに依存しないわけではないコードと混在させると、不一致が生じ、コンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、関数プロトタイプの規則を参照してください。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// USER32.dll (ANSI / -A)
#include <windows.h>
INT_PTR GetWindowLongPtrA(
HWND hWnd,
WINDOW_LONG_PTR_INDEX nIndex
);[DllImport("USER32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern IntPtr GetWindowLongPtrA(
IntPtr hWnd, // HWND
int nIndex // WINDOW_LONG_PTR_INDEX
);<DllImport("USER32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetWindowLongPtrA(
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 GetWindowLongPtrA Lib "user32" ( _
ByVal hWnd As LongPtr, _
ByVal nIndex As Long) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
GetWindowLongPtrA = ctypes.windll.user32.GetWindowLongPtrA
GetWindowLongPtrA.restype = ctypes.c_ssize_t
GetWindowLongPtrA.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')
GetWindowLongPtrA = Fiddle::Function.new(
lib['GetWindowLongPtrA'],
[
Fiddle::TYPE_VOIDP, # hWnd : HWND
Fiddle::TYPE_INT, # nIndex : WINDOW_LONG_PTR_INDEX
],
Fiddle::TYPE_INTPTR_T)#[link(name = "user32")]
extern "system" {
fn GetWindowLongPtrA(
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.Ansi, SetLastError = true)]
public static extern IntPtr GetWindowLongPtrA(IntPtr hWnd, int nIndex);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_GetWindowLongPtrA' -Namespace Win32 -PassThru
# $api::GetWindowLongPtrA(hWnd, nIndex)#uselib "USER32.dll"
#func global GetWindowLongPtrA "GetWindowLongPtrA" sptr, sptr
; GetWindowLongPtrA hWnd, nIndex ; 戻り値は stat
; hWnd : HWND -> "sptr"
; nIndex : WINDOW_LONG_PTR_INDEX -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "USER32.dll"
#cfunc global GetWindowLongPtrA "GetWindowLongPtrA" sptr, int
; res = GetWindowLongPtrA(hWnd, nIndex)
; hWnd : HWND -> "sptr"
; nIndex : WINDOW_LONG_PTR_INDEX -> "int"; INT_PTR GetWindowLongPtrA(HWND hWnd, WINDOW_LONG_PTR_INDEX nIndex)
#uselib "USER32.dll"
#cfunc global GetWindowLongPtrA "GetWindowLongPtrA" intptr, int
; res = GetWindowLongPtrA(hWnd, nIndex)
; hWnd : HWND -> "intptr"
; nIndex : WINDOW_LONG_PTR_INDEX -> "int"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
user32 = windows.NewLazySystemDLL("USER32.dll")
procGetWindowLongPtrA = user32.NewProc("GetWindowLongPtrA")
)
// hWnd (HWND), nIndex (WINDOW_LONG_PTR_INDEX)
r1, _, err := procGetWindowLongPtrA.Call(
uintptr(hWnd),
uintptr(nIndex),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // INT_PTRfunction GetWindowLongPtrA(
hWnd: THandle; // HWND
nIndex: Integer // WINDOW_LONG_PTR_INDEX
): NativeInt; stdcall;
external 'USER32.dll' name 'GetWindowLongPtrA';result := DllCall("USER32\GetWindowLongPtrA"
, "Ptr", hWnd ; HWND
, "Int", nIndex ; WINDOW_LONG_PTR_INDEX
, "Ptr") ; return: INT_PTR●GetWindowLongPtrA(hWnd, nIndex) = DLL("USER32.dll", "int GetWindowLongPtrA(void*, int)")
# 呼び出し: GetWindowLongPtrA(hWnd, nIndex)
# hWnd : HWND -> "void*"
# nIndex : WINDOW_LONG_PTR_INDEX -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "user32" fn GetWindowLongPtrA(
hWnd: ?*anyopaque, // HWND
nIndex: i32 // WINDOW_LONG_PTR_INDEX
) callconv(std.os.windows.WINAPI) isize;proc GetWindowLongPtrA(
hWnd: pointer, # HWND
nIndex: int32 # WINDOW_LONG_PTR_INDEX
): int {.importc: "GetWindowLongPtrA", stdcall, dynlib: "USER32.dll".}pragma(lib, "user32");
extern(Windows)
ptrdiff_t GetWindowLongPtrA(
void* hWnd, // HWND
int nIndex // WINDOW_LONG_PTR_INDEX
);ccall((:GetWindowLongPtrA, "USER32.dll"), stdcall, Int,
(Ptr{Cvoid}, Int32),
hWnd, nIndex)
# hWnd : HWND -> Ptr{Cvoid}
# nIndex : WINDOW_LONG_PTR_INDEX -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
intptr_t GetWindowLongPtrA(
void* hWnd,
int32_t nIndex);
]]
local user32 = ffi.load("user32")
-- user32.GetWindowLongPtrA(hWnd, nIndex)
-- hWnd : HWND
-- nIndex : WINDOW_LONG_PTR_INDEX
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('USER32.dll');
const GetWindowLongPtrA = lib.func('__stdcall', 'GetWindowLongPtrA', 'intptr_t', ['void *', 'int32_t']);
// GetWindowLongPtrA(hWnd, nIndex)
// hWnd : HWND -> 'void *'
// nIndex : WINDOW_LONG_PTR_INDEX -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("USER32.dll", {
GetWindowLongPtrA: { parameters: ["pointer", "i32"], result: "isize" },
});
// lib.symbols.GetWindowLongPtrA(hWnd, nIndex)
// hWnd : HWND -> "pointer"
// nIndex : WINDOW_LONG_PTR_INDEX -> "i32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
intptr_t GetWindowLongPtrA(
void* hWnd,
int32_t nIndex);
C, "USER32.dll");
// $ffi->GetWindowLongPtrA(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.ASCII_OPTIONS);
long GetWindowLongPtrA(
Pointer hWnd, // HWND
int nIndex // WINDOW_LONG_PTR_INDEX
);
}@[Link("user32")]
lib LibUSER32
fun GetWindowLongPtrA = GetWindowLongPtrA(
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 GetWindowLongPtrANative = IntPtr Function(Pointer<Void>, Int32);
typedef GetWindowLongPtrADart = int Function(Pointer<Void>, int);
final GetWindowLongPtrA = DynamicLibrary.open('USER32.dll')
.lookupFunction<GetWindowLongPtrANative, GetWindowLongPtrADart>('GetWindowLongPtrA');
// hWnd : HWND -> Pointer<Void>
// nIndex : WINDOW_LONG_PTR_INDEX -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function GetWindowLongPtrA(
hWnd: THandle; // HWND
nIndex: Integer // WINDOW_LONG_PTR_INDEX
): NativeInt; stdcall;
external 'USER32.dll' name 'GetWindowLongPtrA';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "GetWindowLongPtrA"
c_GetWindowLongPtrA :: 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 getwindowlongptra =
foreign "GetWindowLongPtrA"
((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 ("GetWindowLongPtrA" get-window-long-ptr-a :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 $GetWindowLongPtrA = Win32::API::More->new('USER32',
'LPARAM GetWindowLongPtrA(HANDLE hWnd, int nIndex)');
# my $ret = $GetWindowLongPtrA->Call($hWnd, $nIndex);
# hWnd : HWND -> HANDLE
# nIndex : WINDOW_LONG_PTR_INDEX -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
文字セット違い
- f GetWindowLongPtrW (Unicode版) — ウィンドウの指定情報をポインタ幅で取得する(Unicode)。
公式の関連項目
- f CallWindowProcA — 指定のウィンドウプロシージャを呼び出す(ANSI)。
- f RegisterClassExA — 拡張属性付きでウィンドウクラスを登録する(ANSI)。
- f SetParent — 子ウィンドウの親ウィンドウを変更する。
- f SetWindowLongPtrA — ウィンドウの指定情報をポインタ幅で設定する(ANSI)。
- s WNDCLASSEXA