Win32 API 日本語リファレンス
ホームSystem.Com › CoRevokeClassObject

CoRevokeClassObject

関数
登録済みのクラスオブジェクトの登録を取り消す。
DLLOLE32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// OLE32.dll
#include <windows.h>

HRESULT CoRevokeClassObject(
    DWORD dwRegister
);

パラメーター

名前方向説明
dwRegisterDWORDin以前に CoRegisterClassObject 関数から返されたトークン。

戻り値の型: HRESULT

公式ドキュメント

以前に CoRegisterClassObject 関数で登録されたクラスオブジェクトが、もう使用できなくなったことを OLE に通知します。

戻り値

この関数は、標準の戻り値 E_INVALIDARGE_OUTOFMEMORYE_UNEXPECTED に加えて、以下の値を返すことがあります。

戻り値 説明
S_OK
クラスオブジェクトの登録が正常に取り消されました。

解説(Remarks)

CoRevokeClassObject の呼び出しが成功すると、クラスオブジェクトがグローバルクラスオブジェクトテーブルから削除されます(ただし、クラスオブジェクト自体は解放されません)。他のクライアントがまだクラスオブジェクトへのポインターを保持しており、IUnknown::AddRef の呼び出しによって参照カウントが増加している場合、参照カウントはゼロになりません。この状況が発生したときに、クラスオブジェクトへの以降の呼び出し(明らかな例外として AddRefIUnknown::Release を除く)が失敗するようにすると、アプリケーションにとって都合がよい場合があります。なお、CoRegisterClassObjectAddRef を呼び出し、CoRevokeClassObjectRelease を呼び出すため、この 2 つの関数は AddRef/Release のペアを形成します。

オブジェクトアプリケーションは、プログラムを終了する前に、登録済みのクラスオブジェクトの登録を取り消すために CoRevokeClassObject を呼び出す必要があります。クラスオブジェクトの実装者は、解放処理の一部として CoRevokeClassObject を呼び出すべきです。CoRegisterClassObject の呼び出しでフラグ値 REGCLS_SINGLEUSE を指定し、クラスオブジェクトに接続できるアプリケーションが 1 つだけであることを示した場合でも、クラスオブジェクトの登録は明示的に取り消す必要があります。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// OLE32.dll
#include <windows.h>

HRESULT CoRevokeClassObject(
    DWORD dwRegister
);
[DllImport("OLE32.dll", ExactSpelling = true)]
static extern int CoRevokeClassObject(
    uint dwRegister   // DWORD
);
<DllImport("OLE32.dll", ExactSpelling:=True)>
Public Shared Function CoRevokeClassObject(
    dwRegister As UInteger   ' DWORD
) As Integer
End Function
' dwRegister : DWORD
Declare PtrSafe Function CoRevokeClassObject Lib "ole32" ( _
    ByVal dwRegister As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

CoRevokeClassObject = ctypes.windll.ole32.CoRevokeClassObject
CoRevokeClassObject.restype = ctypes.c_int
CoRevokeClassObject.argtypes = [
    wintypes.DWORD,  # dwRegister : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('OLE32.dll')
CoRevokeClassObject = Fiddle::Function.new(
  lib['CoRevokeClassObject'],
  [
    -Fiddle::TYPE_INT,  # dwRegister : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "ole32")]
extern "system" {
    fn CoRevokeClassObject(
        dwRegister: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("OLE32.dll")]
public static extern int CoRevokeClassObject(uint dwRegister);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLE32_CoRevokeClassObject' -Namespace Win32 -PassThru
# $api::CoRevokeClassObject(dwRegister)
#uselib "OLE32.dll"
#func global CoRevokeClassObject "CoRevokeClassObject" sptr
; CoRevokeClassObject dwRegister   ; 戻り値は stat
; dwRegister : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "OLE32.dll"
#cfunc global CoRevokeClassObject "CoRevokeClassObject" int
; res = CoRevokeClassObject(dwRegister)
; dwRegister : DWORD -> "int"
; HRESULT CoRevokeClassObject(DWORD dwRegister)
#uselib "OLE32.dll"
#cfunc global CoRevokeClassObject "CoRevokeClassObject" int
; res = CoRevokeClassObject(dwRegister)
; dwRegister : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	ole32 = windows.NewLazySystemDLL("OLE32.dll")
	procCoRevokeClassObject = ole32.NewProc("CoRevokeClassObject")
)

// dwRegister (DWORD)
r1, _, err := procCoRevokeClassObject.Call(
	uintptr(dwRegister),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function CoRevokeClassObject(
  dwRegister: DWORD   // DWORD
): Integer; stdcall;
  external 'OLE32.dll' name 'CoRevokeClassObject';
result := DllCall("OLE32\CoRevokeClassObject"
    , "UInt", dwRegister   ; DWORD
    , "Int")   ; return: HRESULT
●CoRevokeClassObject(dwRegister) = DLL("OLE32.dll", "int CoRevokeClassObject(dword)")
# 呼び出し: CoRevokeClassObject(dwRegister)
# dwRegister : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "ole32" fn CoRevokeClassObject(
    dwRegister: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc CoRevokeClassObject(
    dwRegister: uint32  # DWORD
): int32 {.importc: "CoRevokeClassObject", stdcall, dynlib: "OLE32.dll".}
pragma(lib, "ole32");
extern(Windows)
int CoRevokeClassObject(
    uint dwRegister   // DWORD
);
ccall((:CoRevokeClassObject, "OLE32.dll"), stdcall, Int32,
      (UInt32,),
      dwRegister)
# dwRegister : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t CoRevokeClassObject(
    uint32_t dwRegister);
]]
local ole32 = ffi.load("ole32")
-- ole32.CoRevokeClassObject(dwRegister)
-- dwRegister : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('OLE32.dll');
const CoRevokeClassObject = lib.func('__stdcall', 'CoRevokeClassObject', 'int32_t', ['uint32_t']);
// CoRevokeClassObject(dwRegister)
// dwRegister : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("OLE32.dll", {
  CoRevokeClassObject: { parameters: ["u32"], result: "i32" },
});
// lib.symbols.CoRevokeClassObject(dwRegister)
// dwRegister : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t CoRevokeClassObject(
    uint32_t dwRegister);
C, "OLE32.dll");
// $ffi->CoRevokeClassObject(dwRegister);
// dwRegister : DWORD
// 構造体/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 Ole32 extends StdCallLibrary {
    Ole32 INSTANCE = Native.load("ole32", Ole32.class);
    int CoRevokeClassObject(
        int dwRegister   // DWORD
    );
}
@[Link("ole32")]
lib LibOLE32
  fun CoRevokeClassObject = CoRevokeClassObject(
    dwRegister : UInt32   # DWORD
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef CoRevokeClassObjectNative = Int32 Function(Uint32);
typedef CoRevokeClassObjectDart = int Function(int);
final CoRevokeClassObject = DynamicLibrary.open('OLE32.dll')
    .lookupFunction<CoRevokeClassObjectNative, CoRevokeClassObjectDart>('CoRevokeClassObject');
// dwRegister : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CoRevokeClassObject(
  dwRegister: DWORD   // DWORD
): Integer; stdcall;
  external 'OLE32.dll' name 'CoRevokeClassObject';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CoRevokeClassObject"
  c_CoRevokeClassObject :: Word32 -> IO Int32
-- dwRegister : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let corevokeclassobject =
  foreign "CoRevokeClassObject"
    (uint32_t @-> returning int32_t)
(* dwRegister : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library ole32 (t "OLE32.dll"))
(cffi:use-foreign-library ole32)

(cffi:defcfun ("CoRevokeClassObject" co-revoke-class-object :convention :stdcall) :int32
  (dw-register :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CoRevokeClassObject = Win32::API::More->new('OLE32',
    'int CoRevokeClassObject(DWORD dwRegister)');
# my $ret = $CoRevokeClassObject->Call($dwRegister);
# dwRegister : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目