ホーム › UI.WindowsAndMessaging › GetClassInfoA

GetClassInfoA

関数

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

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

シグネチャ

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

BOOL GetClassInfoA(
    HINSTANCE hInstance,   // optional
    LPCSTR lpClassName,
    WNDCLASSA* lpWndClass
);

パラメーター

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

名前

型

方向

説明

hInstance

HINSTANCE

inoptional

クラスを作成したアプリケーションのインスタンスへのハンドルです。システムが定義するクラス(ボタンやリストボックスなど)に関する情報を取得するには、このパラメーターを NULL に設定します。

lpClassName

LPCSTR

クラス名です。この名前は、事前に登録されたクラス、または以前の RegisterClass もしくは RegisterClassEx 関数の呼び出しによって登録されたクラスの名前である必要があります。

あるいは、このパラメーターにはアトムを指定することもできます。その場合、以前の RegisterClass または RegisterClassEx の呼び出しによって作成されたクラスアトムである必要があります。アトムは lpClassName の下位ワードに格納し、上位ワードはゼロにする必要があります。

lpWndClass

WNDCLASSA*

out

クラスに関する情報を受け取る WNDCLASS 構造体へのポインターです。

戻り値の型: BOOL

公式ドキュメント

ウィンドウクラスに関する情報を取得します。(ANSI)

戻り値

型: BOOL

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

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

解説(Remarks)

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 GetClassInfoA(
    HINSTANCE hInstance,   // optional
    LPCSTR lpClassName,
    WNDCLASSA* lpWndClass
);

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

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

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

import ctypes
from ctypes import wintypes

GetClassInfoA = ctypes.windll.user32.GetClassInfoA
GetClassInfoA.restype = wintypes.BOOL
GetClassInfoA.argtypes = [
    wintypes.HANDLE,  # hInstance : HINSTANCE optional
    wintypes.LPCSTR,  # lpClassName : LPCSTR
    ctypes.c_void_p,  # lpWndClass : WNDCLASSA* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
GetClassInfoA = Fiddle::Function.new(
  lib['GetClassInfoA'],
  [
    Fiddle::TYPE_VOIDP,  # hInstance : HINSTANCE optional
    Fiddle::TYPE_VOIDP,  # lpClassName : LPCSTR
    Fiddle::TYPE_VOIDP,  # lpWndClass : WNDCLASSA* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "user32")]
extern "system" {
    fn GetClassInfoA(
        hInstance: *mut core::ffi::c_void,  // HINSTANCE optional
        lpClassName: *const u8,  // LPCSTR
        lpWndClass: *mut WNDCLASSA  // WNDCLASSA* 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 GetClassInfoA(IntPtr hInstance, [MarshalAs(UnmanagedType.LPStr)] string lpClassName, IntPtr lpWndClass);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_GetClassInfoA' -Namespace Win32 -PassThru
# $api::GetClassInfoA(hInstance, lpClassName, lpWndClass)

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

出力引数:

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