ホーム › UI.WindowsAndMessaging › GetClassNameA

GetClassNameA

関数

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

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

シグネチャ

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

INT GetClassNameA(
    HWND hWnd,
    LPSTR lpClassName,
    INT nMaxCount
);

パラメーター

名前	型	方向	説明
hWnd	HWND	in	ウィンドウへのハンドル。間接的に、そのウィンドウが属するクラスを示します。
lpClassName	LPSTR	out	クラス名の文字列。
nMaxCount	INT	in	lpClassName バッファの長さ(文字数)。バッファは終端の null 文字を含められる十分な大きさが必要です。そうでない場合、クラス名の文字列は `nMaxCount-1` 文字に切り詰められます。

戻り値の型: INT

公式ドキュメント

指定したウィンドウが属するクラスの名前を取得します。(GetClassNameA)

戻り値

型: int

関数が成功すると、戻り値はバッファにコピーされた文字数(終端の null 文字を含まない)になります。

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

解説(Remarks)

メモ

winuser.h ヘッダーは GetClassName をエイリアスとして定義しており、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>

INT GetClassNameA(
    HWND hWnd,
    LPSTR lpClassName,
    INT nMaxCount
);

[DllImport("USER32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern int GetClassNameA(
    IntPtr hWnd,   // HWND
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpClassName,   // LPSTR out
    int nMaxCount   // INT
);

<DllImport("USER32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetClassNameA(
    hWnd As IntPtr,   ' HWND
    <MarshalAs(UnmanagedType.LPStr)> lpClassName As System.Text.StringBuilder,   ' LPSTR out
    nMaxCount As Integer   ' INT
) As Integer
End Function

' hWnd : HWND
' lpClassName : LPSTR out
' nMaxCount : INT
Declare PtrSafe Function GetClassNameA Lib "user32" ( _
    ByVal hWnd As LongPtr, _
    ByVal lpClassName As String, _
    ByVal nMaxCount As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetClassNameA = ctypes.windll.user32.GetClassNameA
GetClassNameA.restype = ctypes.c_int
GetClassNameA.argtypes = [
    wintypes.HANDLE,  # hWnd : HWND
    wintypes.LPSTR,  # lpClassName : LPSTR out
    ctypes.c_int,  # nMaxCount : INT
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
GetClassNameA = Fiddle::Function.new(
  lib['GetClassNameA'],
  [
    Fiddle::TYPE_VOIDP,  # hWnd : HWND
    Fiddle::TYPE_VOIDP,  # lpClassName : LPSTR out
    Fiddle::TYPE_INT,  # nMaxCount : INT
  ],
  Fiddle::TYPE_INT)

#[link(name = "user32")]
extern "system" {
    fn GetClassNameA(
        hWnd: *mut core::ffi::c_void,  // HWND
        lpClassName: *mut u8,  // LPSTR out
        nMaxCount: i32  // INT
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("USER32.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern int GetClassNameA(IntPtr hWnd, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpClassName, int nMaxCount);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_GetClassNameA' -Namespace Win32 -PassThru
# $api::GetClassNameA(hWnd, lpClassName, nMaxCount)

#uselib "USER32.dll"
#func global GetClassNameA "GetClassNameA" sptr, sptr, sptr
; GetClassNameA hWnd, varptr(lpClassName), nMaxCount   ; 戻り値は stat
; hWnd : HWND -> "sptr"
; lpClassName : LPSTR out -> "sptr"
; nMaxCount : INT -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "USER32.dll"
#cfunc global GetClassNameA "GetClassNameA" sptr, var, int
; res = GetClassNameA(hWnd, lpClassName, nMaxCount)
; hWnd : HWND -> "sptr"
; lpClassName : LPSTR out -> "var"
; nMaxCount : INT -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "USER32.dll"
#cfunc global GetClassNameA "GetClassNameA" sptr, sptr, int
; res = GetClassNameA(hWnd, varptr(lpClassName), nMaxCount)
; hWnd : HWND -> "sptr"
; lpClassName : LPSTR out -> "sptr"
; nMaxCount : INT -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。