Win32 API 日本語リファレンス
ホームUI.WindowsAndMessaging › UnregisterClassW

UnregisterClassW

関数
登録済みウィンドウクラスを解除する(Unicode)。
DLLUSER32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL UnregisterClassW(
    LPCWSTR lpClassName,
    HINSTANCE hInstance   // optional
);

パラメーター

名前方向説明
lpClassNameLPCWSTRinnull で終わる文字列、またはクラスアトムです。lpClassName が文字列の場合は、ウィンドウクラス名を指定します。このクラス名は、以前に RegisterClass 関数または RegisterClassEx 関数を呼び出して登録されたものでなければなりません。ダイアログボックスコントロールなどのシステムクラスは、登録を解除できません。このパラメーターがアトムの場合は、以前に RegisterClass 関数または RegisterClassEx 関数を呼び出して作成されたクラスアトムでなければなりません。アトムは lpClassName の下位ワードに格納し、上位ワードは 0 でなければなりません。
hInstanceHINSTANCEinoptionalクラスを作成したモジュールのインスタンスへのハンドルです。

戻り値の型: BOOL

公式ドキュメント

ウィンドウクラスの登録を解除し、そのクラスに必要なメモリを解放します。(Unicode)

戻り値

型: BOOL

関数が成功した場合、戻り値は 0 以外になります。

クラスが見つからなかった場合、またはそのクラスで作成されたウィンドウがまだ存在する場合、戻り値は 0 になります。拡張エラー情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

この関数を呼び出す前に、アプリケーションは指定したクラスで作成されたすべてのウィンドウを破棄しておく必要があります。

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

クラスアトムは、RegisterClass および RegisterClassEx によってのみ返される特別なアトムです。

DLL によって登録されたウィンドウクラスは、その .dll がアンロードされても登録解除されません。

メモ

winuser.h ヘッダーは UnregisterClass をエイリアスとして定義しており、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  (Unicode / -W)
#include <windows.h>

BOOL UnregisterClassW(
    LPCWSTR lpClassName,
    HINSTANCE hInstance   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool UnregisterClassW(
    [MarshalAs(UnmanagedType.LPWStr)] string lpClassName,   // LPCWSTR
    IntPtr hInstance   // HINSTANCE optional
);
<DllImport("USER32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function UnregisterClassW(
    <MarshalAs(UnmanagedType.LPWStr)> lpClassName As String,   ' LPCWSTR
    hInstance As IntPtr   ' HINSTANCE optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' lpClassName : LPCWSTR
' hInstance : HINSTANCE optional
Declare PtrSafe Function UnregisterClassW Lib "user32" ( _
    ByVal lpClassName As LongPtr, _
    ByVal hInstance 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

UnregisterClassW = ctypes.windll.user32.UnregisterClassW
UnregisterClassW.restype = wintypes.BOOL
UnregisterClassW.argtypes = [
    wintypes.LPCWSTR,  # lpClassName : LPCWSTR
    wintypes.HANDLE,  # hInstance : HINSTANCE optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
UnregisterClassW = Fiddle::Function.new(
  lib['UnregisterClassW'],
  [
    Fiddle::TYPE_VOIDP,  # lpClassName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # hInstance : HINSTANCE optional
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "user32")]
extern "system" {
    fn UnregisterClassW(
        lpClassName: *const u16,  // LPCWSTR
        hInstance: *mut core::ffi::c_void  // HINSTANCE optional
    ) -> 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 UnregisterClassW([MarshalAs(UnmanagedType.LPWStr)] string lpClassName, IntPtr hInstance);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_UnregisterClassW' -Namespace Win32 -PassThru
# $api::UnregisterClassW(lpClassName, hInstance)
#uselib "USER32.dll"
#func global UnregisterClassW "UnregisterClassW" wptr, wptr
; UnregisterClassW lpClassName, hInstance   ; 戻り値は stat
; lpClassName : LPCWSTR -> "wptr"
; hInstance : HINSTANCE optional -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "USER32.dll"
#cfunc global UnregisterClassW "UnregisterClassW" wstr, sptr
; res = UnregisterClassW(lpClassName, hInstance)
; lpClassName : LPCWSTR -> "wstr"
; hInstance : HINSTANCE optional -> "sptr"
; BOOL UnregisterClassW(LPCWSTR lpClassName, HINSTANCE hInstance)
#uselib "USER32.dll"
#cfunc global UnregisterClassW "UnregisterClassW" wstr, intptr
; res = UnregisterClassW(lpClassName, hInstance)
; lpClassName : LPCWSTR -> "wstr"
; hInstance : HINSTANCE optional -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procUnregisterClassW = user32.NewProc("UnregisterClassW")
)

// lpClassName (LPCWSTR), hInstance (HINSTANCE optional)
r1, _, err := procUnregisterClassW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpClassName))),
	uintptr(hInstance),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function UnregisterClassW(
  lpClassName: PWideChar;   // LPCWSTR
  hInstance: THandle   // HINSTANCE optional
): BOOL; stdcall;
  external 'USER32.dll' name 'UnregisterClassW';
result := DllCall("USER32\UnregisterClassW"
    , "WStr", lpClassName   ; LPCWSTR
    , "Ptr", hInstance   ; HINSTANCE optional
    , "Int")   ; return: BOOL
●UnregisterClassW(lpClassName, hInstance) = DLL("USER32.dll", "bool UnregisterClassW(char*, void*)")
# 呼び出し: UnregisterClassW(lpClassName, hInstance)
# lpClassName : LPCWSTR -> "char*"
# hInstance : HINSTANCE optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "user32" fn UnregisterClassW(
    lpClassName: [*c]const u16, // LPCWSTR
    hInstance: ?*anyopaque // HINSTANCE optional
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc UnregisterClassW(
    lpClassName: WideCString,  # LPCWSTR
    hInstance: pointer  # HINSTANCE optional
): int32 {.importc: "UnregisterClassW", stdcall, dynlib: "USER32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "user32");
extern(Windows)
int UnregisterClassW(
    const(wchar)* lpClassName,   // LPCWSTR
    void* hInstance   // HINSTANCE optional
);
ccall((:UnregisterClassW, "USER32.dll"), stdcall, Int32,
      (Cwstring, Ptr{Cvoid}),
      lpClassName, hInstance)
# lpClassName : LPCWSTR -> Cwstring
# hInstance : HINSTANCE optional -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t UnregisterClassW(
    const uint16_t* lpClassName,
    void* hInstance);
]]
local user32 = ffi.load("user32")
-- user32.UnregisterClassW(lpClassName, hInstance)
-- lpClassName : LPCWSTR
-- hInstance : HINSTANCE optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('USER32.dll');
const UnregisterClassW = lib.func('__stdcall', 'UnregisterClassW', 'int32_t', ['str16', 'void *']);
// UnregisterClassW(lpClassName, hInstance)
// lpClassName : LPCWSTR -> 'str16'
// hInstance : HINSTANCE optional -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("USER32.dll", {
  UnregisterClassW: { parameters: ["buffer", "pointer"], result: "i32" },
});
// lib.symbols.UnregisterClassW(lpClassName, hInstance)
// lpClassName : LPCWSTR -> "buffer"
// hInstance : HINSTANCE optional -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t UnregisterClassW(
    const uint16_t* lpClassName,
    void* hInstance);
C, "USER32.dll");
// $ffi->UnregisterClassW(lpClassName, hInstance);
// lpClassName : LPCWSTR
// hInstance : HINSTANCE optional
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface User32 extends StdCallLibrary {
    User32 INSTANCE = Native.load("user32", User32.class, W32APIOptions.UNICODE_OPTIONS);
    boolean UnregisterClassW(
        WString lpClassName,   // LPCWSTR
        Pointer hInstance   // HINSTANCE optional
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("user32")]
lib LibUSER32
  fun UnregisterClassW = UnregisterClassW(
    lpClassName : UInt16*,   # LPCWSTR
    hInstance : Void*   # HINSTANCE optional
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef UnregisterClassWNative = Int32 Function(Pointer<Utf16>, Pointer<Void>);
typedef UnregisterClassWDart = int Function(Pointer<Utf16>, Pointer<Void>);
final UnregisterClassW = DynamicLibrary.open('USER32.dll')
    .lookupFunction<UnregisterClassWNative, UnregisterClassWDart>('UnregisterClassW');
// lpClassName : LPCWSTR -> Pointer<Utf16>
// hInstance : HINSTANCE optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function UnregisterClassW(
  lpClassName: PWideChar;   // LPCWSTR
  hInstance: THandle   // HINSTANCE optional
): BOOL; stdcall;
  external 'USER32.dll' name 'UnregisterClassW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "UnregisterClassW"
  c_UnregisterClassW :: CWString -> Ptr () -> IO CInt
-- lpClassName : LPCWSTR -> CWString
-- hInstance : HINSTANCE optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let unregisterclassw =
  foreign "UnregisterClassW"
    ((ptr uint16_t) @-> (ptr void) @-> returning int32_t)
(* lpClassName : LPCWSTR -> (ptr uint16_t) *)
(* hInstance : HINSTANCE optional -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)

(cffi:defcfun ("UnregisterClassW" unregister-class-w :convention :stdcall) :int32
  (lp-class-name (:string :encoding :utf-16le))   ; LPCWSTR
  (h-instance :pointer))   ; HINSTANCE optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $UnregisterClassW = Win32::API::More->new('USER32',
    'BOOL UnregisterClassW(LPCWSTR lpClassName, HANDLE hInstance)');
# my $ret = $UnregisterClassW->Call($lpClassName, $hInstance);
# lpClassName : LPCWSTR -> LPCWSTR
# hInstance : HINSTANCE optional -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
公式の関連項目