ホーム › UI.WindowsAndMessaging › GetClassInfoW

GetClassInfoW

関数

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

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

シグネチャ

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

BOOL GetClassInfoW(
    HINSTANCE hInstance,   // optional
    LPCWSTR lpClassName,
    WNDCLASSW* lpWndClass
);

パラメーター

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

名前

型

方向

説明

hInstance

HINSTANCE

inoptional

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

lpClassName

LPCWSTR

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

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

lpWndClass

WNDCLASSW*

out

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

戻り値の型: BOOL

公式ドキュメント

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

戻り値

型: BOOL

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

関数が失敗した場合、戻り値はゼロになります。拡張エラー情報を取得するには、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  (Unicode / -W)
#include <windows.h>

BOOL GetClassInfoW(
    HINSTANCE hInstance,   // optional
    LPCWSTR lpClassName,
    WNDCLASSW* lpWndClass
);

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

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

' hInstance : HINSTANCE optional
' lpClassName : LPCWSTR
' lpWndClass : WNDCLASSW* out
Declare PtrSafe Function GetClassInfoW Lib "user32" ( _
    ByVal hInstance As LongPtr, _
    ByVal lpClassName As LongPtr, _
    ByVal lpWndClass 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

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

require 'fiddle'
require 'fiddle/import'

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

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

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

出力引数:

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