ホーム › System.Com › CoCreateInstanceFromApp

CoCreateInstanceFromApp

関数

アプリコンテナ向けにCOMオブジェクトを生成する。

DLLOLE32.dll呼出規約winapi対応OSwindows8.0

シグネチャ

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

HRESULT CoCreateInstanceFromApp(
    const GUID* Clsid,
    IUnknown* punkOuter,   // optional
    CLSCTX dwClsCtx,
    void* reserved,   // optional
    DWORD dwCount,
    MULTI_QI* pResults
);

パラメーター

名前	型	方向	説明
Clsid	GUID*	in	作成するオブジェクトの CLSID。
punkOuter	IUnknown*	inoptional	このパラメーターが NULL 以外の場合、インスタンスがアグリゲート (集約) の一部として作成されることを示し、punkOuter は新しいインスタンスの制御側 IUnknown として使用されます。アグリゲーションは現在、プロセス間およびコンピューター間ではサポートされていません。オブジェクトをプロセス外でインスタンス化する際に punkOuter が NULL 以外の場合は、CLASS_E_NOAGGREGATION が返されます。
dwClsCtx	CLSCTX	in	CLSCTX 列挙体の値。
reserved	void*	inoptional	将来の使用のために予約されています。
dwCount	DWORD	in	pResults 内の構造体の数。この値は 0 より大きくなければなりません。
pResults	MULTI_QI*	inout	MULTI_QI 構造体の配列。各構造体には 3 つのメンバーがあります。要求するインターフェイスの識別子 (pIID)、インターフェイスポインターを返す格納先 (pItf)、および QueryInterface 呼び出しの戻り値 (hr) です。

戻り値の型: HRESULT

公式ドキュメント

アプリコンテナー内から、指定したコンピューター上に特定のクラスのインスタンスを作成します。

戻り値

この関数は、標準の戻り値 E_INVALIDARG のほか、次の値を返すことがあります。

戻りコード	説明
S_OK	成功したことを示します。
REGDB_E_CLASSNOTREG	指定したクラスがレジストレーションデータベースに登録されていないか、そのクラスがアプリコンテナーでサポートされていません。また、CLSCTX 列挙体で要求したサーバーの種類が登録されていない、またはレジストリ内のサーバー種類の値が破損していることを示す場合もあります。
CLASS_E_NOAGGREGATION	このクラスは、アグリゲートの一部として作成できません。
CO_S_NOTALLINTERFACES	pResults 配列で要求したインターフェイスのうち、少なくとも 1 つは取得できましたが、すべては取得できませんでした。pResults 内の各 MULTI_QI 構造体の hr メンバーは、特定のインターフェイスが返されたかどうかを S_OK または E_NOINTERFACE で示します。
E_NOINTERFACE	pResults 配列で要求したインターフェイスは、いずれも取得できませんでした。

解説(Remarks)

CoCreateInstanceFromApp 関数は CoCreateInstanceEx 関数と同じですが、次の点が異なります。

CoCreateInstanceFromApp 関数は、アプリケーションコンテキストおよび HKLM\SOFTWARE\Classes\CLSID レジストリハイブからのみクラス登録を読み取ります。
アプリコンテナーでサポートされる組み込みクラスのみが提供されます。サードパーティ製コードによってインストールされたすべてのクラスや多くの Windows クラスを含む、サポートされていないクラスをアクティブ化しようとすると、エラーコード REGDB_E_CLASSNOTREG が返されます。
CoCreateInstanceFromApp 関数は Windows ストアアプリで使用できます。デスクトップアプリケーションからもこの関数を呼び出せますが、Windows ストアアプリと同じ制限を受けます。

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

各言語での呼び出し定義

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

HRESULT CoCreateInstanceFromApp(
    const GUID* Clsid,
    IUnknown* punkOuter,   // optional
    CLSCTX dwClsCtx,
    void* reserved,   // optional
    DWORD dwCount,
    MULTI_QI* pResults
);

[DllImport("OLE32.dll", ExactSpelling = true)]
static extern int CoCreateInstanceFromApp(
    ref Guid Clsid,   // GUID*
    IntPtr punkOuter,   // IUnknown* optional
    uint dwClsCtx,   // CLSCTX
    IntPtr reserved,   // void* optional
    uint dwCount,   // DWORD
    IntPtr pResults   // MULTI_QI* in/out
);

<DllImport("OLE32.dll", ExactSpelling:=True)>
Public Shared Function CoCreateInstanceFromApp(
    ByRef Clsid As Guid,   ' GUID*
    punkOuter As IntPtr,   ' IUnknown* optional
    dwClsCtx As UInteger,   ' CLSCTX
    reserved As IntPtr,   ' void* optional
    dwCount As UInteger,   ' DWORD
    pResults As IntPtr   ' MULTI_QI* in/out
) As Integer
End Function

' Clsid : GUID*
' punkOuter : IUnknown* optional
' dwClsCtx : CLSCTX
' reserved : void* optional
' dwCount : DWORD
' pResults : MULTI_QI* in/out
Declare PtrSafe Function CoCreateInstanceFromApp Lib "ole32" ( _
    ByVal Clsid As LongPtr, _
    ByVal punkOuter As LongPtr, _
    ByVal dwClsCtx As Long, _
    ByVal reserved As LongPtr, _
    ByVal dwCount As Long, _
    ByVal pResults As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CoCreateInstanceFromApp = ctypes.windll.ole32.CoCreateInstanceFromApp
CoCreateInstanceFromApp.restype = ctypes.c_int
CoCreateInstanceFromApp.argtypes = [
    ctypes.c_void_p,  # Clsid : GUID*
    ctypes.c_void_p,  # punkOuter : IUnknown* optional
    wintypes.DWORD,  # dwClsCtx : CLSCTX
    ctypes.POINTER(None),  # reserved : void* optional
    wintypes.DWORD,  # dwCount : DWORD
    ctypes.c_void_p,  # pResults : MULTI_QI* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('OLE32.dll')
CoCreateInstanceFromApp = Fiddle::Function.new(
  lib['CoCreateInstanceFromApp'],
  [
    Fiddle::TYPE_VOIDP,  # Clsid : GUID*
    Fiddle::TYPE_VOIDP,  # punkOuter : IUnknown* optional
    -Fiddle::TYPE_INT,  # dwClsCtx : CLSCTX
    Fiddle::TYPE_VOIDP,  # reserved : void* optional
    -Fiddle::TYPE_INT,  # dwCount : DWORD
    Fiddle::TYPE_VOIDP,  # pResults : MULTI_QI* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "ole32")]
extern "system" {
    fn CoCreateInstanceFromApp(
        Clsid: *const GUID,  // GUID*
        punkOuter: *mut core::ffi::c_void,  // IUnknown* optional
        dwClsCtx: u32,  // CLSCTX
        reserved: *mut (),  // void* optional
        dwCount: u32,  // DWORD
        pResults: *mut MULTI_QI  // MULTI_QI* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("OLE32.dll")]
public static extern int CoCreateInstanceFromApp(ref Guid Clsid, IntPtr punkOuter, uint dwClsCtx, IntPtr reserved, uint dwCount, IntPtr pResults);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLE32_CoCreateInstanceFromApp' -Namespace Win32 -PassThru
# $api::CoCreateInstanceFromApp(Clsid, punkOuter, dwClsCtx, reserved, dwCount, pResults)

#uselib "OLE32.dll"
#func global CoCreateInstanceFromApp "CoCreateInstanceFromApp" sptr, sptr, sptr, sptr, sptr, sptr
; CoCreateInstanceFromApp varptr(Clsid), punkOuter, dwClsCtx, reserved, dwCount, varptr(pResults)   ; 戻り値は stat
; Clsid : GUID* -> "sptr"
; punkOuter : IUnknown* optional -> "sptr"
; dwClsCtx : CLSCTX -> "sptr"
; reserved : void* optional -> "sptr"
; dwCount : DWORD -> "sptr"
; pResults : MULTI_QI* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "OLE32.dll"
#cfunc global CoCreateInstanceFromApp "CoCreateInstanceFromApp" var, sptr, int, sptr, int, var
; res = CoCreateInstanceFromApp(Clsid, punkOuter, dwClsCtx, reserved, dwCount, pResults)
; Clsid : GUID* -> "var"
; punkOuter : IUnknown* optional -> "sptr"
; dwClsCtx : CLSCTX -> "int"
; reserved : void* optional -> "sptr"
; dwCount : DWORD -> "int"
; pResults : MULTI_QI* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "OLE32.dll"
#cfunc global CoCreateInstanceFromApp "CoCreateInstanceFromApp" sptr, sptr, int, sptr, int, sptr
; res = CoCreateInstanceFromApp(varptr(Clsid), punkOuter, dwClsCtx, reserved, dwCount, varptr(pResults))
; Clsid : GUID* -> "sptr"
; punkOuter : IUnknown* optional -> "sptr"
; dwClsCtx : CLSCTX -> "int"
; reserved : void* optional -> "sptr"
; dwCount : DWORD -> "int"
; pResults : MULTI_QI* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。