ホーム › UI.WindowsAndMessaging › RegisterClassExA

RegisterClassExA

関数

拡張属性付きでウィンドウクラスを登録する(ANSI)。

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

シグネチャ

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

WORD RegisterClassExA(
    const WNDCLASSEXA* param0
);

パラメーター

名前	型	方向	説明
param0	WNDCLASSEXA*	in	登録するウィンドウクラスの属性を格納したWNDCLASSEXA構造体へのポインタ。cbSizeに構造体サイズを設定する。

戻り値の型: WORD

公式ドキュメント

後続の CreateWindow または CreateWindowEx 関数の呼び出しで使用するウィンドウクラスを登録します。(RegisterClassExA)

戻り値

型: ATOM

関数が成功した場合、戻り値は登録されるクラスを一意に識別するクラスアトムです。このアトムは、CreateWindow、CreateWindowEx、GetClassInfo、GetClassInfoEx、FindWindow、FindWindowEx、UnregisterClass の各関数、および IActiveIMMap::FilterClientWindows メソッドでのみ使用できます。

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

解説(Remarks)

RegisterClassExA を使用してウィンドウクラスを登録した場合、アプリケーションは、作成されたクラスのウィンドウがテキストまたは文字パラメーターを含むメッセージに ANSI 文字セットを使用することを期待している、とシステムに伝えます。RegisterClassExW を使用して登録した場合、アプリケーションは、メッセージのテキストパラメーターを Unicode として渡すことをシステムに要求します。IsWindowUnicode 関数を使用すると、アプリケーションは各ウィンドウの性質を照会できます。ANSI 関数と Unicode 関数の詳細については、Conventions for Function Prototypes を参照してください。

アプリケーションが登録したすべてのウィンドウクラスは、アプリケーションが終了するときに登録解除されます。

DLL によって登録されたウィンドウクラスは、DLL がアンロードされても登録解除されません。DLL はアンロードされるときに、自身のクラスを明示的に登録解除する必要があります。

例

例については、Using Window Classes を参照してください。

メモ

winuser.h ヘッダーは、RegisterClassEx を、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>

WORD RegisterClassExA(
    const WNDCLASSEXA* param0
);

[DllImport("USER32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern ushort RegisterClassExA(
    IntPtr param0   // WNDCLASSEXA*
);

<DllImport("USER32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function RegisterClassExA(
    param0 As IntPtr   ' WNDCLASSEXA*
) As UShort
End Function

' param0 : WNDCLASSEXA*
Declare PtrSafe Function RegisterClassExA Lib "user32" ( _
    ByVal param0 As LongPtr) As Integer
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

RegisterClassExA = ctypes.windll.user32.RegisterClassExA
RegisterClassExA.restype = ctypes.c_ushort
RegisterClassExA.argtypes = [
    ctypes.c_void_p,  # param0 : WNDCLASSEXA*
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
RegisterClassExA = Fiddle::Function.new(
  lib['RegisterClassExA'],
  [
    Fiddle::TYPE_VOIDP,  # param0 : WNDCLASSEXA*
  ],
  -Fiddle::TYPE_SHORT)

#[link(name = "user32")]
extern "system" {
    fn RegisterClassExA(
        param0: *const WNDCLASSEXA  // WNDCLASSEXA*
    ) -> u16;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("USER32.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern ushort RegisterClassExA(IntPtr param0);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_RegisterClassExA' -Namespace Win32 -PassThru
# $api::RegisterClassExA(param0)

#uselib "USER32.dll"
#func global RegisterClassExA "RegisterClassExA" sptr
; RegisterClassExA varptr(param0)   ; 戻り値は stat
; param0 : WNDCLASSEXA* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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