ホーム › UI.WindowsAndMessaging › RegisterClassA

RegisterClassA

関数

ウィンドウクラスを登録する(ANSI)。

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

シグネチャ

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

WORD RegisterClassA(
    const WNDCLASSA* lpWndClass
);

パラメーター

名前	型	方向	説明
lpWndClass	WNDCLASSA*	in	WNDCLASS 構造体へのポインターです。この関数に渡す前に、構造体へ適切なクラス属性を設定しておく必要があります。

戻り値の型: WORD

公式ドキュメント

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

戻り値

型: ATOM

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

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

解説(Remarks)

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

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

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

例

例については、「Associating a Window Procedure with a Window Class」を参照してください。

メモ

winuser.h ヘッダーは RegisterClass を、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 RegisterClassA(
    const WNDCLASSA* lpWndClass
);

[DllImport("USER32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern ushort RegisterClassA(
    IntPtr lpWndClass   // WNDCLASSA*
);

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

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

import ctypes
from ctypes import wintypes

RegisterClassA = ctypes.windll.user32.RegisterClassA
RegisterClassA.restype = ctypes.c_ushort
RegisterClassA.argtypes = [
    ctypes.c_void_p,  # lpWndClass : WNDCLASSA*
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
RegisterClassA = Fiddle::Function.new(
  lib['RegisterClassA'],
  [
    Fiddle::TYPE_VOIDP,  # lpWndClass : WNDCLASSA*
  ],
  -Fiddle::TYPE_SHORT)

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

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

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

出力引数:

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