ホーム › UI.WindowsAndMessaging › GetClassInfoExA

GetClassInfoExA

関数

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

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

シグネチャ

// USER32.dll  (ANSI / -A)
#include <windows.h>

BOOL GetClassInfoExA(
    HINSTANCE hInstance,   // optional
    LPCSTR lpszClass,
    WNDCLASSEXA* lpwcx
);

パラメーター

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

戻り値の型: BOOL

公式ドキュメント

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

戻り値

型: BOOL

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

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

解説(Remarks)

クラスアトムは、RegisterClass または RegisterClassEx 関数を使用して作成されるものであり、 GlobalAddAtom 関数では作成されません。

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// USER32.dll  (ANSI / -A)
#include <windows.h>

BOOL GetClassInfoExA(
    HINSTANCE hInstance,   // optional
    LPCSTR lpszClass,
    WNDCLASSEXA* lpwcx
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool GetClassInfoExA(
    IntPtr hInstance,   // HINSTANCE optional
    [MarshalAs(UnmanagedType.LPStr)] string lpszClass,   // LPCSTR
    IntPtr lpwcx   // WNDCLASSEXA* out
);

<DllImport("USER32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetClassInfoExA(
    hInstance As IntPtr,   ' HINSTANCE optional
    <MarshalAs(UnmanagedType.LPStr)> lpszClass As String,   ' LPCSTR
    lpwcx As IntPtr   ' WNDCLASSEXA* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hInstance : HINSTANCE optional
' lpszClass : LPCSTR
' lpwcx : WNDCLASSEXA* out
Declare PtrSafe Function GetClassInfoExA Lib "user32" ( _
    ByVal hInstance As LongPtr, _
    ByVal lpszClass As String, _
    ByVal lpwcx As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

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

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
GetClassInfoExA = Fiddle::Function.new(
  lib['GetClassInfoExA'],
  [
    Fiddle::TYPE_VOIDP,  # hInstance : HINSTANCE optional
    Fiddle::TYPE_VOIDP,  # lpszClass : LPCSTR
    Fiddle::TYPE_VOIDP,  # lpwcx : WNDCLASSEXA* out
  ],
  Fiddle::TYPE_INT)

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

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

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

出力引数:

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