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

GetClassLongPtrW

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

シグネチャ

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

UINT_PTR GetClassLongPtrW(
    HWND hWnd,
    GET_CLASS_LONG_INDEX nIndex
);

パラメーター

名前方向説明
hWndHWNDinウィンドウへのハンドル、および間接的にそのウィンドウが属するクラスへのハンドルです。
nIndexGET_CLASS_LONG_INDEXin

取得する値です。追加クラスメモリから値を取得するには、取得する値の正の 0 から始まるバイトオフセットを指定します。有効な値の範囲は、0 から追加クラスメモリのバイト数から 8 を引いた値までです。たとえば、24 バイト以上の追加クラスメモリを指定した場合、値 16 は 3 番目の整数へのインデックスになります。WNDCLASSEX 構造体からその他の値を取得するには、次のいずれかの値を指定します。

意味
GCW_ATOM
-32
ウィンドウクラスを一意に識別する
                    <b>ATOM</b> 値を取得します。これは <a href="/windows/desktop/api/winuser/nf-winuser-registerclassexa">RegisterClassEx</a> 関数が返すアトムと同じものです。
GCL_CBCLSEXTRA
-20
クラスに関連付けられた追加メモリのサイズ(バイト単位)を取得します。
GCL_CBWNDEXTRA
-18
クラス内の各ウィンドウに関連付けられた追加ウィンドウメモリのサイズ(バイト単位)を取得します。このメモリへのアクセス方法については、GetWindowLongPtr を参照してください。
GCLP_HBRBACKGROUND
-10
クラスに関連付けられた背景ブラシへのハンドルを取得します。
GCLP_HCURSOR
-12
クラスに関連付けられたカーソルへのハンドルを取得します。
GCLP_HICON
-14
クラスに関連付けられたアイコンへのハンドルを取得します。
GCLP_HICONSM
-34
クラスに関連付けられた小さいアイコンへのハンドルを取得します。
GCLP_HMODULE
-16
クラスを登録したモジュールへのハンドルを取得します。
GCLP_MENUNAME
-8
メニュー名文字列へのポインターを取得します。この文字列は、クラスに関連付けられたメニューリソースを識別します。
GCL_STYLE
-26
ウィンドウクラスのスタイルビットを取得します。
GCLP_WNDPROC
-24
ウィンドウプロシージャのアドレス、またはウィンドウプロシージャのアドレスを表すハンドルを取得します。ウィンドウプロシージャを呼び出すには、CallWindowProc 関数を使用する必要があります。

戻り値の型: UINT_PTR

公式ドキュメント

指定したウィンドウに関連付けられた WNDCLASSEX 構造体から、指定した値を取得します。(Unicode)

戻り値

型: ULONG_PTR

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

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

解説(Remarks)

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

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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>

UINT_PTR GetClassLongPtrW(
    HWND hWnd,
    GET_CLASS_LONG_INDEX nIndex
);
[DllImport("USER32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern UIntPtr GetClassLongPtrW(
    IntPtr hWnd,   // HWND
    int nIndex   // GET_CLASS_LONG_INDEX
);
<DllImport("USER32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetClassLongPtrW(
    hWnd As IntPtr,   ' HWND
    nIndex As Integer   ' GET_CLASS_LONG_INDEX
) As UIntPtr
End Function
' hWnd : HWND
' nIndex : GET_CLASS_LONG_INDEX
Declare PtrSafe Function GetClassLongPtrW 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

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

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

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procGetClassLongPtrW = user32.NewProc("GetClassLongPtrW")
)

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

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

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

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

let getclasslongptrw =
  foreign "GetClassLongPtrW"
    ((ptr void) @-> int32_t @-> returning size_t)
(* hWnd : HWND -> (ptr void) *)
(* nIndex : GET_CLASS_LONG_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 ("GetClassLongPtrW" get-class-long-ptr-w :convention :stdcall) :uint64
  (h-wnd :pointer)   ; HWND
  (n-index :int32))   ; GET_CLASS_LONG_INDEX
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetClassLongPtrW = Win32::API::More->new('USER32',
    'WPARAM GetClassLongPtrW(HANDLE hWnd, int nIndex)');
# my $ret = $GetClassLongPtrW->Call($hWnd, $nIndex);
# hWnd : HWND -> HANDLE
# nIndex : GET_CLASS_LONG_INDEX -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

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