ホーム › UI.WindowsAndMessaging › GetClassInfoExW

GetClassInfoExW

関数

拡張ウィンドウクラス情報を取得する(Unicode)。

DLLUSER32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL GetClassInfoExW(
    HINSTANCE hInstance,   // optional
    LPCWSTR lpszClass,
    WNDCLASSEXW* lpwcx
);

パラメーター

名前	型	方向	説明
hInstance	HINSTANCE	inoptional	クラスを作成したアプリケーションのインスタンスへのハンドル。システムによって定義されたクラス(ボタンやリストボックスなど)に関する情報を取得するには、このパラメーターを NULL に設定します。
lpszClass	LPCWSTR	in	クラス名。この名前は、あらかじめ登録されたクラス、または以前の RegisterClass もしくは RegisterClassEx 関数の呼び出しによって登録されたクラスのものでなければなりません。あるいは、このパラメーターには、以前の RegisterClass または RegisterClassEx の呼び出しによって作成されたクラスアトムを指定することもできます。アトムは lpszClass の下位ワードに格納されている必要があり、上位ワードはゼロでなければなりません。
lpwcx	WNDCLASSEXW*	out	クラスに関する情報を受け取る WNDCLASSEX 構造体へのポインター。

戻り値の型: BOOL

公式ドキュメント

ウィンドウクラスに関する情報を取得します。これには、ウィンドウクラスに関連付けられた小さいアイコンへのハンドルが含まれます。GetClassInfo 関数は小さいアイコンへのハンドルを取得しません。(Unicode)

戻り値

型: BOOL

関数が一致するクラスを見つけ、データのコピーに成功した場合、戻り値は 0 以外になります。

関数が一致するクラスを見つけられず、データのコピーに失敗した場合、戻り値は 0 になります。拡張エラー情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

クラスアトムは、GlobalAddAtom 関数ではなく、RegisterClass または RegisterClassEx 関数を使用して作成されます。

メモ

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

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

BOOL GetClassInfoExW(
    HINSTANCE hInstance,   // optional
    LPCWSTR lpszClass,
    WNDCLASSEXW* lpwcx
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool GetClassInfoExW(
    IntPtr hInstance,   // HINSTANCE optional
    [MarshalAs(UnmanagedType.LPWStr)] string lpszClass,   // LPCWSTR
    IntPtr lpwcx   // WNDCLASSEXW* out
);

<DllImport("USER32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetClassInfoExW(
    hInstance As IntPtr,   ' HINSTANCE optional
    <MarshalAs(UnmanagedType.LPWStr)> lpszClass As String,   ' LPCWSTR
    lpwcx As IntPtr   ' WNDCLASSEXW* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hInstance : HINSTANCE optional
' lpszClass : LPCWSTR
' lpwcx : WNDCLASSEXW* out
Declare PtrSafe Function GetClassInfoExW Lib "user32" ( _
    ByVal hInstance As LongPtr, _
    ByVal lpszClass As LongPtr, _
    ByVal lpwcx As LongPtr) 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

GetClassInfoExW = ctypes.windll.user32.GetClassInfoExW
GetClassInfoExW.restype = wintypes.BOOL
GetClassInfoExW.argtypes = [
    wintypes.HANDLE,  # hInstance : HINSTANCE optional
    wintypes.LPCWSTR,  # lpszClass : LPCWSTR
    ctypes.c_void_p,  # lpwcx : WNDCLASSEXW* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
GetClassInfoExW = Fiddle::Function.new(
  lib['GetClassInfoExW'],
  [
    Fiddle::TYPE_VOIDP,  # hInstance : HINSTANCE optional
    Fiddle::TYPE_VOIDP,  # lpszClass : LPCWSTR
    Fiddle::TYPE_VOIDP,  # lpwcx : WNDCLASSEXW* out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "user32")]
extern "system" {
    fn GetClassInfoExW(
        hInstance: *mut core::ffi::c_void,  // HINSTANCE optional
        lpszClass: *const u16,  // LPCWSTR
        lpwcx: *mut WNDCLASSEXW  // WNDCLASSEXW* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern bool GetClassInfoExW(IntPtr hInstance, [MarshalAs(UnmanagedType.LPWStr)] string lpszClass, IntPtr lpwcx);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_GetClassInfoExW' -Namespace Win32 -PassThru
# $api::GetClassInfoExW(hInstance, lpszClass, lpwcx)

#uselib "USER32.dll"
#func global GetClassInfoExW "GetClassInfoExW" wptr, wptr, wptr
; GetClassInfoExW hInstance, lpszClass, varptr(lpwcx)   ; 戻り値は stat
; hInstance : HINSTANCE optional -> "wptr"
; lpszClass : LPCWSTR -> "wptr"
; lpwcx : WNDCLASSEXW* out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "USER32.dll"
#cfunc global GetClassInfoExW "GetClassInfoExW" sptr, wstr, var
; res = GetClassInfoExW(hInstance, lpszClass, lpwcx)
; hInstance : HINSTANCE optional -> "sptr"
; lpszClass : LPCWSTR -> "wstr"
; lpwcx : WNDCLASSEXW* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "USER32.dll"
#cfunc global GetClassInfoExW "GetClassInfoExW" sptr, wstr, sptr
; res = GetClassInfoExW(hInstance, lpszClass, varptr(lpwcx))
; hInstance : HINSTANCE optional -> "sptr"
; lpszClass : LPCWSTR -> "wstr"
; lpwcx : WNDCLASSEXW* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。