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

CoGetClassObject

関数
指定CLSIDのクラスファクトリオブジェクトを取得する。
DLLOLE32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

HRESULT CoGetClassObject(
    const GUID* rclsid,
    DWORD dwClsContext,
    void* pvReserved,   // optional
    const GUID* riid,
    void** ppv
);

パラメーター

名前方向説明
rclsidGUID*inオブジェクトの作成に使用するデータおよびコードに関連付けられた CLSID。
dwClsContextDWORDin実行可能コードが実行されるコンテキスト。リモートアクティベーションを有効にするには、CLSCTX_REMOTE_SERVER を含めます。コンテキスト値とその使用方法の詳細については、CLSCTX 列挙型を参照してください。
pvReservedvoid*inoptionalクラスオブジェクトをインスタンス化するコンピューターへのポインター。このパラメーターが NULL の場合、クラスオブジェクトは、dwClsCtx パラメーターの解釈に従って、現在のコンピューター上、またはクラスの RemoteServerName キーで指定されたコンピューター上でインスタンス化されます。COSERVERINFO を参照してください。
riidGUID*inインターフェイスの識別子への参照。正常に復帰すると ppv に格納されます。このインターフェイスは、クラスオブジェクトとの通信に使用されます。通常この値は IID_IClassFactory ですが、ライセンスの一形態をサポートする IID_IClassFactory2 などの他の値も許可されます。OLE で定義されたすべてのインターフェイス IID は、OLE ヘッダーファイル内で IID_interfacename として定義されます。ここで interfacename はインターフェイスの名前です。
ppvvoid**outriid で要求されたインターフェイスポインターを受け取るポインター変数のアドレス。正常に復帰すると、*ppv に要求されたインターフェイスポインターが格納されます。

戻り値の型: HRESULT

公式ドキュメント

指定した CLSID に関連付けられたクラスオブジェクト上のインターフェイスへのポインターを提供します。

戻り値

この関数は次の値を返すことがあります。

戻り値 説明
S_OK
指定したクラスオブジェクトの検索と接続に成功しました。
REGDB_E_CLASSNOTREG
CLSID が正しく登録されていません。このエラーは、dwClsContext に指定した値がレジストリに存在しないことを示す場合もあります。
E_NOINTERFACE
ppv が指すオブジェクトが riid で識別されるインターフェイスをサポートしていないか、クラスオブジェクトに対する QueryInterface 操作が E_NOINTERFACE を返しました。
REGDB_E_READREGDB
登録データベースの読み取り中にエラーが発生しました。
CO_E_DLLNOTFOUND
インプロセス DLL またはハンドラー DLL が見つかりませんでした(コンテキストによって異なります)。
CO_E_APPNOTFOUND
実行可能ファイル (.exe) が見つかりませんでした(CLSCTX_LOCAL_SERVER の場合のみ)。
E_ACCESSDENIED
読み込み時に一般的なアクセスエラーが発生しました。
CO_E_ERRORINDLL
実行可能イメージにエラーがあります。
CO_E_APPDIDNTREG
実行可能ファイルは起動されましたが、クラスオブジェクトを登録しませんでした(既にシャットダウンしている可能性もあります)。

解説(Remarks)

OLE におけるクラスオブジェクトとは、オブジェクトのグループに共通する操作を可能にするインターフェイスをサポートする中間オブジェクトです。このグループ内のオブジェクトは、単一の CLSID で表される同一のオブジェクト定義から派生したインスタンスです。通常、クラスオブジェクトに実装されるインターフェイスは IClassFactory であり、これを通じて特定の定義(クラス)のオブジェクトインスタンスを作成できます。

CoGetClassObject を呼び出すと、クラスオブジェクトが作成および初期化され、呼び出し元が(riid パラメーターで指定したインターフェイスへのポインターを通じて)アクセスできるようになります。このクラスオブジェクトは、rclsid パラメーターで指定した CLSID に関連付けられたものです。システムがコンピューター内で関連するコードとデータを見つける方法の詳細は、まだ読み込まれていないコードの動的な読み込みと同様に、呼び出し元からは透過的です。

クラスコンテキストが CLSCTX_REMOTE_SERVER の場合(リモートアクティベーションが必要であることを示します)、pServerInfo パラメーターで指定する COSERVERINFO 構造体によって、サーバーが配置されているコンピューターを指定できます。pServerInfoNULL の場合にリモートサーバーを見つけるために使用されるアルゴリズムについては、CLSCTX 列挙型を参照してください。

クラスの CLSID を見つける場所は 2 つあります。

埋め込みまたはリンクされた OLE ドキュメントオブジェクトを作成および初期化するために、CoGetClassObject を直接呼び出す必要はありません。代わりに、OleCreate または OleCreateXXX 関数を呼び出します。これらの関数はオブジェクトのインスタンス化と初期化の全プロセスをカプセル化しており、その中で CoGetClassObject などの関数を呼び出します。

riid パラメーターは、クライアントがクラスオブジェクトとの通信に使用するインターフェイスを指定します。ほとんどの場合、このインターフェイスは IClassFactory です。これにより CreateInstance メソッドにアクセスでき、呼び出し元はその実装で指定された種類の未初期化オブジェクトを作成できます。CLSID を持つシステムに登録されたすべてのクラスは、IClassFactory を実装する必要があります。

ただし、まれに、オブジェクトのセットに共通する操作を定義する他のインターフェイスを指定したい場合があります。たとえば、OLE がモニカーを実装する方法では、クラスオブジェクト上のインターフェイスは IParseDisplayName であり、オブジェクトの表示名をモニカーに変換するために使用されます。

dwClsContext パラメーターは実行コンテキストを指定し、1 つの CLSID を異なる実行コンテキストにおける異なるコードに関連付けることを可能にします。CLSCTX 列挙型は、利用可能なコンテキストフラグを指定します。CoGetClassObject は、(指定されたコンテキストに応じて)レジストリと、CoRegisterClassObject 関数を呼び出して現在登録されているクラスオブジェクトの両方を参照します。

クラスオブジェクトを解放するには、クラスオブジェクトの Release メソッドを使用します。CoRevokeClassObject 関数は、システムレジストリからクラスオブジェクトの CLSID を削除するためにのみ使用されます。

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

各言語での呼び出し定義

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

HRESULT CoGetClassObject(
    const GUID* rclsid,
    DWORD dwClsContext,
    void* pvReserved,   // optional
    const GUID* riid,
    void** ppv
);
[DllImport("OLE32.dll", ExactSpelling = true)]
static extern int CoGetClassObject(
    ref Guid rclsid,   // GUID*
    uint dwClsContext,   // DWORD
    IntPtr pvReserved,   // void* optional
    ref Guid riid,   // GUID*
    IntPtr ppv   // void** out
);
<DllImport("OLE32.dll", ExactSpelling:=True)>
Public Shared Function CoGetClassObject(
    ByRef rclsid As Guid,   ' GUID*
    dwClsContext As UInteger,   ' DWORD
    pvReserved As IntPtr,   ' void* optional
    ByRef riid As Guid,   ' GUID*
    ppv As IntPtr   ' void** out
) As Integer
End Function
' rclsid : GUID*
' dwClsContext : DWORD
' pvReserved : void* optional
' riid : GUID*
' ppv : void** out
Declare PtrSafe Function CoGetClassObject Lib "ole32" ( _
    ByVal rclsid As LongPtr, _
    ByVal dwClsContext As Long, _
    ByVal pvReserved As LongPtr, _
    ByVal riid As LongPtr, _
    ByVal ppv As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

CoGetClassObject = ctypes.windll.ole32.CoGetClassObject
CoGetClassObject.restype = ctypes.c_int
CoGetClassObject.argtypes = [
    ctypes.c_void_p,  # rclsid : GUID*
    wintypes.DWORD,  # dwClsContext : DWORD
    ctypes.POINTER(None),  # pvReserved : void* optional
    ctypes.c_void_p,  # riid : GUID*
    ctypes.c_void_p,  # ppv : void** out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('OLE32.dll')
CoGetClassObject = Fiddle::Function.new(
  lib['CoGetClassObject'],
  [
    Fiddle::TYPE_VOIDP,  # rclsid : GUID*
    -Fiddle::TYPE_INT,  # dwClsContext : DWORD
    Fiddle::TYPE_VOIDP,  # pvReserved : void* optional
    Fiddle::TYPE_VOIDP,  # riid : GUID*
    Fiddle::TYPE_VOIDP,  # ppv : void** out
  ],
  Fiddle::TYPE_INT)
#[link(name = "ole32")]
extern "system" {
    fn CoGetClassObject(
        rclsid: *const GUID,  // GUID*
        dwClsContext: u32,  // DWORD
        pvReserved: *mut (),  // void* optional
        riid: *const GUID,  // GUID*
        ppv: *mut *mut ()  // void** out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("OLE32.dll")]
public static extern int CoGetClassObject(ref Guid rclsid, uint dwClsContext, IntPtr pvReserved, ref Guid riid, IntPtr ppv);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLE32_CoGetClassObject' -Namespace Win32 -PassThru
# $api::CoGetClassObject(rclsid, dwClsContext, pvReserved, riid, ppv)
#uselib "OLE32.dll"
#func global CoGetClassObject "CoGetClassObject" sptr, sptr, sptr, sptr, sptr
; CoGetClassObject varptr(rclsid), dwClsContext, pvReserved, varptr(riid), ppv   ; 戻り値は stat
; rclsid : GUID* -> "sptr"
; dwClsContext : DWORD -> "sptr"
; pvReserved : void* optional -> "sptr"
; riid : GUID* -> "sptr"
; ppv : void** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "OLE32.dll"
#cfunc global CoGetClassObject "CoGetClassObject" var, int, sptr, var, sptr
; res = CoGetClassObject(rclsid, dwClsContext, pvReserved, riid, ppv)
; rclsid : GUID* -> "var"
; dwClsContext : DWORD -> "int"
; pvReserved : void* optional -> "sptr"
; riid : GUID* -> "var"
; ppv : void** out -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT CoGetClassObject(GUID* rclsid, DWORD dwClsContext, void* pvReserved, GUID* riid, void** ppv)
#uselib "OLE32.dll"
#cfunc global CoGetClassObject "CoGetClassObject" var, int, intptr, var, intptr
; res = CoGetClassObject(rclsid, dwClsContext, pvReserved, riid, ppv)
; rclsid : GUID* -> "var"
; dwClsContext : DWORD -> "int"
; pvReserved : void* optional -> "intptr"
; riid : GUID* -> "var"
; ppv : void** out -> "intptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	ole32 = windows.NewLazySystemDLL("OLE32.dll")
	procCoGetClassObject = ole32.NewProc("CoGetClassObject")
)

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

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

typedef CoGetClassObjectNative = Int32 Function(Pointer<Void>, Uint32, Pointer<Void>, Pointer<Void>, Pointer<Void>);
typedef CoGetClassObjectDart = int Function(Pointer<Void>, int, Pointer<Void>, Pointer<Void>, Pointer<Void>);
final CoGetClassObject = DynamicLibrary.open('OLE32.dll')
    .lookupFunction<CoGetClassObjectNative, CoGetClassObjectDart>('CoGetClassObject');
// rclsid : GUID* -> Pointer<Void>
// dwClsContext : DWORD -> Uint32
// pvReserved : void* optional -> Pointer<Void>
// riid : GUID* -> Pointer<Void>
// ppv : void** out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CoGetClassObject(
  rclsid: PGUID;   // GUID*
  dwClsContext: DWORD;   // DWORD
  pvReserved: Pointer;   // void* optional
  riid: PGUID;   // GUID*
  ppv: Pointer   // void** out
): Integer; stdcall;
  external 'OLE32.dll' name 'CoGetClassObject';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CoGetClassObject"
  c_CoGetClassObject :: Ptr () -> Word32 -> Ptr () -> Ptr () -> Ptr () -> IO Int32
-- rclsid : GUID* -> Ptr ()
-- dwClsContext : DWORD -> Word32
-- pvReserved : void* optional -> Ptr ()
-- riid : GUID* -> Ptr ()
-- ppv : void** out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let cogetclassobject =
  foreign "CoGetClassObject"
    ((ptr void) @-> uint32_t @-> (ptr void) @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* rclsid : GUID* -> (ptr void) *)
(* dwClsContext : DWORD -> uint32_t *)
(* pvReserved : void* optional -> (ptr void) *)
(* riid : GUID* -> (ptr void) *)
(* ppv : void** out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library ole32 (t "OLE32.dll"))
(cffi:use-foreign-library ole32)

(cffi:defcfun ("CoGetClassObject" co-get-class-object :convention :stdcall) :int32
  (rclsid :pointer)   ; GUID*
  (dw-cls-context :uint32)   ; DWORD
  (pv-reserved :pointer)   ; void* optional
  (riid :pointer)   ; GUID*
  (ppv :pointer))   ; void** out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CoGetClassObject = Win32::API::More->new('OLE32',
    'int CoGetClassObject(LPVOID rclsid, DWORD dwClsContext, LPVOID pvReserved, LPVOID riid, LPVOID ppv)');
# my $ret = $CoGetClassObject->Call($rclsid, $dwClsContext, $pvReserved, $riid, $ppv);
# rclsid : GUID* -> LPVOID
# dwClsContext : DWORD -> DWORD
# pvReserved : void* optional -> LPVOID
# riid : GUID* -> LPVOID
# ppv : void** out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目