OleCreate

関数

指定したCLSIDの新しい埋め込みOLEオブジェクトを作成する。

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

シグネチャ

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

HRESULT OleCreate(
    const GUID* rclsid,
    const GUID* riid,
    DWORD renderopt,
    FORMATETC* pFormatEtc,
    IOleClientSite* pClientSite,
    IStorage* pStg,
    void** ppvObj
);

パラメーター

名前	型	方向	説明
rclsid	GUID*	in	作成する埋め込みオブジェクトの CLSID。
riid	GUID*	in	インターフェイスの識別子への参照。通常は IID_IOleObject (OLE ヘッダーで IOleObject のインターフェイス識別子として定義されています) を指定します。呼び出し元はこのインターフェイスを介して新しいオブジェクトと通信します。
renderopt	DWORD	in	列挙型 OLERENDER の値で、新しく作成されるオブジェクトが持つべきローカルにキャッシュされる描画機能を示します。選択した OLERENDER 値は、pFormatEtc パラメーターに指定できる値に影響します。
pFormatEtc	FORMATETC*	in	renderopt の値として使用される OLERENDER フラグに応じて、FORMATETC 列挙値のいずれかへのポインター。制限事項については OLERENDER 列挙型を参照してください。このパラメーターは renderopt パラメーターとともに、新しいオブジェクトが初期状態でキャッシュできる内容を指定します。
pClientSite	IOleClientSite*	in	OleCreate に IOleObject::SetClientSite を呼び出させたい場合は、コンテナー上の IOleClientSite インターフェイスへのポインター。この値は NULL でもかまいませんが、その場合は操作を実行する前に明示的に IOleObject::SetClientSite を呼び出す必要があります。
pStg	IStorage*	in	ストレージオブジェクト上の IStorage インターフェイスのインスタンスへのポインター。このパラメーターを NULL にすることはできません。
ppvObj	void**	out	riid で要求されたインターフェイスポインターを受け取るポインター変数のアドレス。正常に返された場合、*ppvObject には要求されたインターフェイスポインターが格納されます。

戻り値の型: HRESULT

公式ドキュメント

OleCreate 関数 (ole2.h) は、CLSID で識別される埋め込みオブジェクトを作成します。エンドユーザーがオブジェクトを挿入できるメニュー項目を実装するために使用できます。

戻り値

この関数は成功時に S_OK を返し、標準の戻り値 E_OUTOFMEMORY をサポートします。

戻り値コード	説明
E_OUTOFMEMORY	操作に必要なメモリが不足しています。

解説(Remarks)

OleCreate 関数は新しい埋め込みオブジェクトを作成し、通常はメニュー項目「オブジェクトの挿入 (Insert New Object)」を実装するために呼び出されます。OleCreate が返るとき、作成されたオブジェクトは (renderopt が OLERENDER_DRAW または OLERENDER_FORMAT でない限り) 空 (データを含まない) であり、ロードされた状態です。通常、コンテナーはその後 OleRun 関数または IOleObject::DoVerb を呼び出して、初期編集のためにオブジェクトを表示します。

rclsid パラメーターは、要求されるオブジェクトの CLSID を指定します。登録済みオブジェクトの CLSID はシステムレジストリに格納されています。アプリケーションのユーザーが「オブジェクトの挿入」を選択すると、選択ボックスによってレジストリ内のオブジェクトから目的のオブジェクトの種類を選択できます。「オブジェクトの挿入」メニュー項目の実装に OleCreate を使用する場合、選択された項目に関連付けられた CLSID が OleCreate の rclsid パラメーターに割り当てられます。

riid パラメーターは、クライアントが新しいオブジェクトと通信するために使用するインターフェイスを指定します。正常に返された場合、ppvObject パラメーターには要求されたインターフェイスへのポインターが格納されます。

作成されたオブジェクトのキャッシュには、コンテナーを開いたときに格納されているオブジェクトを表示できるようにする情報が含まれます。何をキャッシュすべきかに関する情報は、renderopt および pFormatetc の値で渡されます。OleCreate が返るとき、作成されたオブジェクトのキャッシュは必ずしも満たされているとは限りません。代わりに、オブジェクトが最初に実行状態に入ったときにキャッシュが満たされます。呼び出し元は、OleCreate が返った後オブジェクトが実行される前に、IOleCache::Cache を呼び出して追加のキャッシュ制御を加えることができます。renderopt が OLERENDER_DRAW または OLERENDER_FORMAT の場合、OleCreate はオブジェクトが IOleCache インターフェイスをサポートしていることを要求します。renderopt のその他の値については、このような要求はありません。

pClientSite が NULL 以外の場合、OleCreate は pClientSite ポインターを介して IOleObject::SetClientSite を呼び出します。IOleClientSite は、オブジェクトがコンテナーにサービスを要求するための主要なインターフェイスです。pClientSite が NULL の場合、操作を実行する前に IOleObject::SetClientSite を明示的に呼び出す必要があります。

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

各言語での呼び出し定義

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

HRESULT OleCreate(
    const GUID* rclsid,
    const GUID* riid,
    DWORD renderopt,
    FORMATETC* pFormatEtc,
    IOleClientSite* pClientSite,
    IStorage* pStg,
    void** ppvObj
);

[DllImport("OLE32.dll", ExactSpelling = true)]
static extern int OleCreate(
    ref Guid rclsid,   // GUID*
    ref Guid riid,   // GUID*
    uint renderopt,   // DWORD
    IntPtr pFormatEtc,   // FORMATETC*
    IntPtr pClientSite,   // IOleClientSite*
    IntPtr pStg,   // IStorage*
    IntPtr ppvObj   // void** out
);

<DllImport("OLE32.dll", ExactSpelling:=True)>
Public Shared Function OleCreate(
    ByRef rclsid As Guid,   ' GUID*
    ByRef riid As Guid,   ' GUID*
    renderopt As UInteger,   ' DWORD
    pFormatEtc As IntPtr,   ' FORMATETC*
    pClientSite As IntPtr,   ' IOleClientSite*
    pStg As IntPtr,   ' IStorage*
    ppvObj As IntPtr   ' void** out
) As Integer
End Function

' rclsid : GUID*
' riid : GUID*
' renderopt : DWORD
' pFormatEtc : FORMATETC*
' pClientSite : IOleClientSite*
' pStg : IStorage*
' ppvObj : void** out
Declare PtrSafe Function OleCreate Lib "ole32" ( _
    ByVal rclsid As LongPtr, _
    ByVal riid As LongPtr, _
    ByVal renderopt As Long, _
    ByVal pFormatEtc As LongPtr, _
    ByVal pClientSite As LongPtr, _
    ByVal pStg As LongPtr, _
    ByVal ppvObj As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

OleCreate = ctypes.windll.ole32.OleCreate
OleCreate.restype = ctypes.c_int
OleCreate.argtypes = [
    ctypes.c_void_p,  # rclsid : GUID*
    ctypes.c_void_p,  # riid : GUID*
    wintypes.DWORD,  # renderopt : DWORD
    ctypes.c_void_p,  # pFormatEtc : FORMATETC*
    ctypes.c_void_p,  # pClientSite : IOleClientSite*
    ctypes.c_void_p,  # pStg : IStorage*
    ctypes.c_void_p,  # ppvObj : void** out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('OLE32.dll')
OleCreate = Fiddle::Function.new(
  lib['OleCreate'],
  [
    Fiddle::TYPE_VOIDP,  # rclsid : GUID*
    Fiddle::TYPE_VOIDP,  # riid : GUID*
    -Fiddle::TYPE_INT,  # renderopt : DWORD
    Fiddle::TYPE_VOIDP,  # pFormatEtc : FORMATETC*
    Fiddle::TYPE_VOIDP,  # pClientSite : IOleClientSite*
    Fiddle::TYPE_VOIDP,  # pStg : IStorage*
    Fiddle::TYPE_VOIDP,  # ppvObj : void** out
  ],
  Fiddle::TYPE_INT)

#[link(name = "ole32")]
extern "system" {
    fn OleCreate(
        rclsid: *const GUID,  // GUID*
        riid: *const GUID,  // GUID*
        renderopt: u32,  // DWORD
        pFormatEtc: *mut FORMATETC,  // FORMATETC*
        pClientSite: *mut core::ffi::c_void,  // IOleClientSite*
        pStg: *mut core::ffi::c_void,  // IStorage*
        ppvObj: *mut *mut ()  // void** out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("OLE32.dll")]
public static extern int OleCreate(ref Guid rclsid, ref Guid riid, uint renderopt, IntPtr pFormatEtc, IntPtr pClientSite, IntPtr pStg, IntPtr ppvObj);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLE32_OleCreate' -Namespace Win32 -PassThru
# $api::OleCreate(rclsid, riid, renderopt, pFormatEtc, pClientSite, pStg, ppvObj)

#uselib "OLE32.dll"
#func global OleCreate "OleCreate" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; OleCreate varptr(rclsid), varptr(riid), renderopt, varptr(pFormatEtc), pClientSite, pStg, ppvObj   ; 戻り値は stat
; rclsid : GUID* -> "sptr"
; riid : GUID* -> "sptr"
; renderopt : DWORD -> "sptr"
; pFormatEtc : FORMATETC* -> "sptr"
; pClientSite : IOleClientSite* -> "sptr"
; pStg : IStorage* -> "sptr"
; ppvObj : void** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "OLE32.dll"
#cfunc global OleCreate "OleCreate" var, var, int, var, sptr, sptr, sptr
; res = OleCreate(rclsid, riid, renderopt, pFormatEtc, pClientSite, pStg, ppvObj)
; rclsid : GUID* -> "var"
; riid : GUID* -> "var"
; renderopt : DWORD -> "int"
; pFormatEtc : FORMATETC* -> "var"
; pClientSite : IOleClientSite* -> "sptr"
; pStg : IStorage* -> "sptr"
; ppvObj : void** out -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "OLE32.dll"
#cfunc global OleCreate "OleCreate" sptr, sptr, int, sptr, sptr, sptr, sptr
; res = OleCreate(varptr(rclsid), varptr(riid), renderopt, varptr(pFormatEtc), pClientSite, pStg, ppvObj)
; rclsid : GUID* -> "sptr"
; riid : GUID* -> "sptr"
; renderopt : DWORD -> "int"
; pFormatEtc : FORMATETC* -> "sptr"
; pClientSite : IOleClientSite* -> "sptr"
; pStg : IStorage* -> "sptr"
; ppvObj : void** out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。