ホーム › UI.WindowsAndMessaging › RegisterClassW

RegisterClassW

関数

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

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

シグネチャ

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

WORD RegisterClassW(
    const WNDCLASSW* lpWndClass
);

パラメーター

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

戻り値の型: WORD

公式ドキュメント

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

戻り値

型: ATOM

関数が成功すると、登録されるクラスを一意に識別するクラスアトムが返されます。このアトムは、CreateWindow、CreateWindowEx、GetClassInfo、GetClassInfoEx、FindWindow、FindWindowEx、UnregisterClass の各関数、および IActiveIMMap::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 ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして RegisterClass を定義します。エンコーディング非依存のエイリアスの使用を、エンコーディング非依存でないコードと混在させると、不一致が生じ、コンパイルエラーまたは実行時エラーの原因となることがあります。詳細については、「Conventions for Function Prototypes」を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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>

WORD RegisterClassW(
    const WNDCLASSW* lpWndClass
);

[DllImport("USER32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern ushort RegisterClassW(
    IntPtr lpWndClass   // WNDCLASSW*
);

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

' lpWndClass : WNDCLASSW*
Declare PtrSafe Function RegisterClassW Lib "user32" ( _
    ByVal lpWndClass As LongPtr) As Integer
' 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

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

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
RegisterClassW = Fiddle::Function.new(
  lib['RegisterClassW'],
  [
    Fiddle::TYPE_VOIDP,  # lpWndClass : WNDCLASSW*
  ],
  -Fiddle::TYPE_SHORT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

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

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

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

出力引数:

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