ホーム › System.Com › CoRegisterClassObject

CoRegisterClassObject

関数

クラスオブジェクトをOLEに登録して接続可能にする。

DLLOLE32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

HRESULT CoRegisterClassObject(
    const GUID* rclsid,
    IUnknown* pUnk,
    CLSCTX dwClsContext,
    DWORD flags,
    DWORD* lpdwRegister
);

パラメーター

名前	型	方向	説明
rclsid	GUID*	in	登録する CLSID。
pUnk	IUnknown*	in	可用性を公開するクラスオブジェクト上の IUnknown インターフェイスへのポインター。
dwClsContext	CLSCTX	in	実行可能コードを実行するコンテキスト。これらのコンテキスト値については、CLSCTX 列挙体を参照してください。
flags	DWORD	in	クラスオブジェクトへの接続方法を示します。これらのフラグについては、REGCLS 列挙体を参照してください。
lpdwRegister	DWORD*	out	登録されたクラスオブジェクトを識別する値へのポインター。後で CoRevokeClassObject 関数が登録を解除するために使用します。

戻り値の型: HRESULT

公式ドキュメント

EXE クラスオブジェクトを OLE に登録し、他のアプリケーションが接続できるようにします。

戻り値

この関数は、標準の戻り値 E_INVALIDARG、E_OUTOFMEMORY、E_UNEXPECTED に加えて、次の値を返すことができます。

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

解説(Remarks)

EXE オブジェクトアプリケーションは、起動時に CoRegisterClassObject を呼び出す必要があります。また、同じ EXE や、その EXE が使用する他のコード (DLL など) で使用する内部オブジェクトを登録するためにも使用できます。 CoRegisterClassObject を呼び出すのは EXE オブジェクトアプリケーションのみです。オブジェクトハンドラーや DLL オブジェクトアプリケーションはこの関数を呼び出しません。代わりに、DllGetClassObject 関数を実装してエクスポートする必要があります。

起動時、複数回使用可能な EXE オブジェクトアプリケーションは、(IClassFactory インターフェイスを備えた) クラスオブジェクトを作成し、CoRegisterClassObject を呼び出してそのクラスオブジェクトを登録する必要があります。複数の異なるクラス (複数の種類の埋め込み可能オブジェクトなど) をサポートするオブジェクトアプリケーションは、クラスごとに別個のクラスオブジェクトを割り当てて登録する必要があります。

同じクラスオブジェクトを複数回登録しても、それらは互いに独立しており、エラーは発生しません。後続の登録ごとに、lpdwRegister に一意のキーが返されます。

マルチドキュメントインターフェイス (MDI) アプリケーションは、クラスオブジェクトを登録する必要があります。シングルドキュメントインターフェイス (SDI) アプリケーションは、/Embedding スイッチによって起動できる場合にのみ、クラスオブジェクトを登録する必要があります。

クラスオブジェクトのサーバーは、次のすべてが成り立つ場合に、CoRevokeClassObject を呼び出してクラスオブジェクトを取り消す (登録を解除する) 必要があります。

オブジェクト定義の既存のインスタンスが存在しない。
クラスオブジェクトに対するロックが存在しない。
クラスオブジェクトにサービスを提供しているアプリケーションがユーザーの制御下にない (ディスプレイ上でユーザーに表示されていない)。

クラスオブジェクトが取り消された後、その参照カウントがゼロに達すると、クラスオブジェクトを解放でき、アプリケーションは終了できるようになります。なお、CoRegisterClassObject は IUnknown::AddRef を呼び出し、CoRevokeClassObject は IUnknown::Release を呼び出すため、この 2 つの関数は AddRef/Release のペアを形成します。

Windows Server 2003 以降では、COM オブジェクトアプリケーションがサービスとして登録されている場合、COM は登録を検証します。COM は、サービスコントロールマネージャー (SCM) におけるサービスのプロセス ID が、登録を行うプロセスのプロセス ID と一致することを確認します。一致しない場合、COM は登録を失敗させます。COM オブジェクトアプリケーションがレジストリキーを持たずにシステムアカウントで実行される場合、COM はそのオブジェクトアプリケーションの ID を起動ユーザー (Launching User) として扱います。

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

各言語での呼び出し定義

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

HRESULT CoRegisterClassObject(
    const GUID* rclsid,
    IUnknown* pUnk,
    CLSCTX dwClsContext,
    DWORD flags,
    DWORD* lpdwRegister
);

[DllImport("OLE32.dll", ExactSpelling = true)]
static extern int CoRegisterClassObject(
    ref Guid rclsid,   // GUID*
    IntPtr pUnk,   // IUnknown*
    uint dwClsContext,   // CLSCTX
    uint flags,   // DWORD
    out uint lpdwRegister   // DWORD* out
);

<DllImport("OLE32.dll", ExactSpelling:=True)>
Public Shared Function CoRegisterClassObject(
    ByRef rclsid As Guid,   ' GUID*
    pUnk As IntPtr,   ' IUnknown*
    dwClsContext As UInteger,   ' CLSCTX
    flags As UInteger,   ' DWORD
    <Out> ByRef lpdwRegister As UInteger   ' DWORD* out
) As Integer
End Function

' rclsid : GUID*
' pUnk : IUnknown*
' dwClsContext : CLSCTX
' flags : DWORD
' lpdwRegister : DWORD* out
Declare PtrSafe Function CoRegisterClassObject Lib "ole32" ( _
    ByVal rclsid As LongPtr, _
    ByVal pUnk As LongPtr, _
    ByVal dwClsContext As Long, _
    ByVal flags As Long, _
    ByRef lpdwRegister As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CoRegisterClassObject = ctypes.windll.ole32.CoRegisterClassObject
CoRegisterClassObject.restype = ctypes.c_int
CoRegisterClassObject.argtypes = [
    ctypes.c_void_p,  # rclsid : GUID*
    ctypes.c_void_p,  # pUnk : IUnknown*
    wintypes.DWORD,  # dwClsContext : CLSCTX
    wintypes.DWORD,  # flags : DWORD
    ctypes.POINTER(wintypes.DWORD),  # lpdwRegister : DWORD* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('OLE32.dll')
CoRegisterClassObject = Fiddle::Function.new(
  lib['CoRegisterClassObject'],
  [
    Fiddle::TYPE_VOIDP,  # rclsid : GUID*
    Fiddle::TYPE_VOIDP,  # pUnk : IUnknown*
    -Fiddle::TYPE_INT,  # dwClsContext : CLSCTX
    -Fiddle::TYPE_INT,  # flags : DWORD
    Fiddle::TYPE_VOIDP,  # lpdwRegister : DWORD* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "ole32")]
extern "system" {
    fn CoRegisterClassObject(
        rclsid: *const GUID,  // GUID*
        pUnk: *mut core::ffi::c_void,  // IUnknown*
        dwClsContext: u32,  // CLSCTX
        flags: u32,  // DWORD
        lpdwRegister: *mut u32  // DWORD* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("OLE32.dll")]
public static extern int CoRegisterClassObject(ref Guid rclsid, IntPtr pUnk, uint dwClsContext, uint flags, out uint lpdwRegister);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLE32_CoRegisterClassObject' -Namespace Win32 -PassThru
# $api::CoRegisterClassObject(rclsid, pUnk, dwClsContext, flags, lpdwRegister)

#uselib "OLE32.dll"
#func global CoRegisterClassObject "CoRegisterClassObject" sptr, sptr, sptr, sptr, sptr
; CoRegisterClassObject varptr(rclsid), pUnk, dwClsContext, flags, varptr(lpdwRegister)   ; 戻り値は stat
; rclsid : GUID* -> "sptr"
; pUnk : IUnknown* -> "sptr"
; dwClsContext : CLSCTX -> "sptr"
; flags : DWORD -> "sptr"
; lpdwRegister : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "OLE32.dll"
#cfunc global CoRegisterClassObject "CoRegisterClassObject" var, sptr, int, int, var
; res = CoRegisterClassObject(rclsid, pUnk, dwClsContext, flags, lpdwRegister)
; rclsid : GUID* -> "var"
; pUnk : IUnknown* -> "sptr"
; dwClsContext : CLSCTX -> "int"
; flags : DWORD -> "int"
; lpdwRegister : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "OLE32.dll"
#cfunc global CoRegisterClassObject "CoRegisterClassObject" sptr, sptr, int, int, sptr
; res = CoRegisterClassObject(varptr(rclsid), pUnk, dwClsContext, flags, varptr(lpdwRegister))
; rclsid : GUID* -> "sptr"
; pUnk : IUnknown* -> "sptr"
; dwClsContext : CLSCTX -> "int"
; flags : DWORD -> "int"
; lpdwRegister : DWORD* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。